forked from Cavemanon/cavepaintings
PSR-2. I'm not a huge fan, but ugly consistency beats no consistency...
This commit is contained in:
Shish
453
core/event.php
453
core/event.php
@@ -4,8 +4,11 @@
|
||||
*
|
||||
* An event is anything that can be passed around via send_event($blah)
|
||||
*/
|
||||
abstract class Event {
|
||||
public function __construct() {}
|
||||
abstract class Event
|
||||
{
|
||||
public function __construct()
|
||||
{
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -16,7 +19,9 @@ abstract class Event {
|
||||
*
|
||||
* This event is sent before $user is set to anything
|
||||
*/
|
||||
class InitExtEvent extends Event {}
|
||||
class InitExtEvent extends Event
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
@@ -27,188 +32,197 @@ class InitExtEvent extends Event {}
|
||||
* true and ignores the matched part, such that $event->count_args() = 1 and
|
||||
* $event->get_arg(0) = "42"
|
||||
*/
|
||||
class PageRequestEvent extends Event {
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
public $args;
|
||||
class PageRequestEvent extends Event
|
||||
{
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
public $args;
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
public $arg_count;
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
public $arg_count;
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
public $part_count;
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
public $part_count;
|
||||
|
||||
public function __construct(string $path) {
|
||||
global $config;
|
||||
public function __construct(string $path)
|
||||
{
|
||||
global $config;
|
||||
|
||||
// trim starting slashes
|
||||
$path = ltrim($path, "/");
|
||||
// trim starting slashes
|
||||
$path = ltrim($path, "/");
|
||||
|
||||
// if path is not specified, use the default front page
|
||||
if(empty($path)) { /* empty is faster than strlen */
|
||||
$path = $config->get_string('front_page');
|
||||
}
|
||||
// if path is not specified, use the default front page
|
||||
if (empty($path)) { /* empty is faster than strlen */
|
||||
$path = $config->get_string('front_page');
|
||||
}
|
||||
|
||||
// break the path into parts
|
||||
$args = explode('/', $path);
|
||||
// break the path into parts
|
||||
$args = explode('/', $path);
|
||||
|
||||
// voodoo so that an arg can contain a slash; is
|
||||
// this still needed?
|
||||
if(strpos($path, "^") !== FALSE) {
|
||||
$unescaped = array();
|
||||
foreach($args as $part) {
|
||||
$unescaped[] = _decaret($part);
|
||||
}
|
||||
$args = $unescaped;
|
||||
}
|
||||
// voodoo so that an arg can contain a slash; is
|
||||
// this still needed?
|
||||
if (strpos($path, "^") !== false) {
|
||||
$unescaped = [];
|
||||
foreach ($args as $part) {
|
||||
$unescaped[] = _decaret($part);
|
||||
}
|
||||
$args = $unescaped;
|
||||
}
|
||||
|
||||
$this->args = $args;
|
||||
$this->arg_count = count($args);
|
||||
}
|
||||
$this->args = $args;
|
||||
$this->arg_count = count($args);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test if the requested path matches a given pattern.
|
||||
*
|
||||
* If it matches, store the remaining path elements in $args
|
||||
*/
|
||||
public function page_matches(string $name): bool {
|
||||
$parts = explode("/", $name);
|
||||
$this->part_count = count($parts);
|
||||
/**
|
||||
* Test if the requested path matches a given pattern.
|
||||
*
|
||||
* If it matches, store the remaining path elements in $args
|
||||
*/
|
||||
public function page_matches(string $name): bool
|
||||
{
|
||||
$parts = explode("/", $name);
|
||||
$this->part_count = count($parts);
|
||||
|
||||
if($this->part_count > $this->arg_count) {
|
||||
return false;
|
||||
}
|
||||
if ($this->part_count > $this->arg_count) {
|
||||
return false;
|
||||
}
|
||||
|
||||
for($i=0; $i<$this->part_count; $i++) {
|
||||
if($parts[$i] != $this->args[$i]) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
for ($i=0; $i<$this->part_count; $i++) {
|
||||
if ($parts[$i] != $this->args[$i]) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the n th argument of the page request (if it exists.)
|
||||
*/
|
||||
public function get_arg(int $n): ?string {
|
||||
$offset = $this->part_count + $n;
|
||||
if($offset >= 0 && $offset < $this->arg_count) {
|
||||
return $this->args[$offset];
|
||||
}
|
||||
else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Get the n th argument of the page request (if it exists.)
|
||||
*/
|
||||
public function get_arg(int $n): ?string
|
||||
{
|
||||
$offset = $this->part_count + $n;
|
||||
if ($offset >= 0 && $offset < $this->arg_count) {
|
||||
return $this->args[$offset];
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of arguments the page request has.
|
||||
*/
|
||||
public function count_args(): int {
|
||||
return int_escape($this->arg_count - $this->part_count);
|
||||
}
|
||||
/**
|
||||
* Returns the number of arguments the page request has.
|
||||
*/
|
||||
public function count_args(): int
|
||||
{
|
||||
return int_escape($this->arg_count - $this->part_count);
|
||||
}
|
||||
|
||||
/*
|
||||
* Many things use these functions
|
||||
*/
|
||||
/*
|
||||
* Many things use these functions
|
||||
*/
|
||||
|
||||
public function get_search_terms(): array {
|
||||
$search_terms = array();
|
||||
if($this->count_args() === 2) {
|
||||
$search_terms = Tag::explode($this->get_arg(0));
|
||||
}
|
||||
return $search_terms;
|
||||
}
|
||||
public function get_search_terms(): array
|
||||
{
|
||||
$search_terms = [];
|
||||
if ($this->count_args() === 2) {
|
||||
$search_terms = Tag::explode($this->get_arg(0));
|
||||
}
|
||||
return $search_terms;
|
||||
}
|
||||
|
||||
public function get_page_number(): int {
|
||||
$page_number = 1;
|
||||
if($this->count_args() === 1) {
|
||||
$page_number = int_escape($this->get_arg(0));
|
||||
}
|
||||
else if($this->count_args() === 2) {
|
||||
$page_number = int_escape($this->get_arg(1));
|
||||
}
|
||||
if($page_number === 0) $page_number = 1; // invalid -> 0
|
||||
return $page_number;
|
||||
}
|
||||
public function get_page_number(): int
|
||||
{
|
||||
$page_number = 1;
|
||||
if ($this->count_args() === 1) {
|
||||
$page_number = int_escape($this->get_arg(0));
|
||||
} elseif ($this->count_args() === 2) {
|
||||
$page_number = int_escape($this->get_arg(1));
|
||||
}
|
||||
if ($page_number === 0) {
|
||||
$page_number = 1;
|
||||
} // invalid -> 0
|
||||
return $page_number;
|
||||
}
|
||||
|
||||
public function get_page_size(): int {
|
||||
global $config;
|
||||
return $config->get_int('index_images');
|
||||
}
|
||||
public function get_page_size(): int
|
||||
{
|
||||
global $config;
|
||||
return $config->get_int('index_images');
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Sent when index.php is called from the command line
|
||||
*/
|
||||
class CommandEvent extends Event {
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
public $cmd = "help";
|
||||
class CommandEvent extends Event
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
public $cmd = "help";
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
public $args = array();
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
public $args = [];
|
||||
|
||||
/**
|
||||
* #param string[] $args
|
||||
*/
|
||||
public function __construct(array $args) {
|
||||
global $user;
|
||||
/**
|
||||
* #param string[] $args
|
||||
*/
|
||||
public function __construct(array $args)
|
||||
{
|
||||
global $user;
|
||||
|
||||
$opts = array();
|
||||
$log_level = SCORE_LOG_WARNING;
|
||||
$opts = [];
|
||||
$log_level = SCORE_LOG_WARNING;
|
||||
$arg_count = count($args);
|
||||
|
||||
for($i=1; $i<$arg_count; $i++) {
|
||||
switch($args[$i]) {
|
||||
case '-u':
|
||||
$user = User::by_name($args[++$i]);
|
||||
if(is_null($user)) {
|
||||
die("Unknown user");
|
||||
}
|
||||
break;
|
||||
case '-q':
|
||||
$log_level += 10;
|
||||
break;
|
||||
case '-v':
|
||||
$log_level -= 10;
|
||||
break;
|
||||
default:
|
||||
$opts[] = $args[$i];
|
||||
break;
|
||||
}
|
||||
}
|
||||
for ($i=1; $i<$arg_count; $i++) {
|
||||
switch ($args[$i]) {
|
||||
case '-u':
|
||||
$user = User::by_name($args[++$i]);
|
||||
if (is_null($user)) {
|
||||
die("Unknown user");
|
||||
}
|
||||
break;
|
||||
case '-q':
|
||||
$log_level += 10;
|
||||
break;
|
||||
case '-v':
|
||||
$log_level -= 10;
|
||||
break;
|
||||
default:
|
||||
$opts[] = $args[$i];
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
define("CLI_LOG_LEVEL", $log_level);
|
||||
define("CLI_LOG_LEVEL", $log_level);
|
||||
|
||||
if(count($opts) > 0) {
|
||||
$this->cmd = $opts[0];
|
||||
$this->args = array_slice($opts, 1);
|
||||
}
|
||||
else {
|
||||
print "\n";
|
||||
print "Usage: php {$args[0]} [flags] [command]\n";
|
||||
print "\n";
|
||||
print "Flags:\n";
|
||||
print " -u [username]\n";
|
||||
print " Log in as the specified user\n";
|
||||
print " -q / -v\n";
|
||||
print " Be quieter / more verbose\n";
|
||||
print " Scale is debug - info - warning - error - critical\n";
|
||||
print " Default is to show warnings and above\n";
|
||||
print " \n";
|
||||
print "Currently known commands:\n";
|
||||
}
|
||||
}
|
||||
if (count($opts) > 0) {
|
||||
$this->cmd = $opts[0];
|
||||
$this->args = array_slice($opts, 1);
|
||||
} else {
|
||||
print "\n";
|
||||
print "Usage: php {$args[0]} [flags] [command]\n";
|
||||
print "\n";
|
||||
print "Flags:\n";
|
||||
print " -u [username]\n";
|
||||
print " Log in as the specified user\n";
|
||||
print " -q / -v\n";
|
||||
print " Be quieter / more verbose\n";
|
||||
print " Scale is debug - info - warning - error - critical\n";
|
||||
print " Default is to show warnings and above\n";
|
||||
print " \n";
|
||||
print "Currently known commands:\n";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -216,82 +230,85 @@ class CommandEvent extends Event {
|
||||
* A signal that some text needs formatting, the event carries
|
||||
* both the text and the result
|
||||
*/
|
||||
class TextFormattingEvent extends Event {
|
||||
/**
|
||||
* For reference
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $original;
|
||||
class TextFormattingEvent extends Event
|
||||
{
|
||||
/**
|
||||
* For reference
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $original;
|
||||
|
||||
/**
|
||||
* with formatting applied
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $formatted;
|
||||
/**
|
||||
* with formatting applied
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $formatted;
|
||||
|
||||
/**
|
||||
* with formatting removed
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $stripped;
|
||||
/**
|
||||
* with formatting removed
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $stripped;
|
||||
|
||||
public function __construct(string $text) {
|
||||
$h_text = html_escape(trim($text));
|
||||
$this->original = $h_text;
|
||||
$this->formatted = $h_text;
|
||||
$this->stripped = $h_text;
|
||||
}
|
||||
public function __construct(string $text)
|
||||
{
|
||||
$h_text = html_escape(trim($text));
|
||||
$this->original = $h_text;
|
||||
$this->formatted = $h_text;
|
||||
$this->stripped = $h_text;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* A signal that something needs logging
|
||||
*/
|
||||
class LogEvent extends Event {
|
||||
/**
|
||||
* a category, normally the extension name
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $section;
|
||||
class LogEvent extends Event
|
||||
{
|
||||
/**
|
||||
* a category, normally the extension name
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $section;
|
||||
|
||||
/**
|
||||
* See python...
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $priority = 0;
|
||||
/**
|
||||
* See python...
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $priority = 0;
|
||||
|
||||
/**
|
||||
* Free text to be logged
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $message;
|
||||
/**
|
||||
* Free text to be logged
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $message;
|
||||
|
||||
/**
|
||||
* The time that the event was created
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $time;
|
||||
/**
|
||||
* The time that the event was created
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $time;
|
||||
|
||||
/**
|
||||
* Extra data to be held separate
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $args;
|
||||
/**
|
||||
* Extra data to be held separate
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $args;
|
||||
|
||||
public function __construct(string $section, int $priority, string $message, array $args) {
|
||||
$this->section = $section;
|
||||
$this->priority = $priority;
|
||||
$this->message = $message;
|
||||
$this->args = $args;
|
||||
$this->time = time();
|
||||
}
|
||||
public function __construct(string $section, int $priority, string $message, array $args)
|
||||
{
|
||||
$this->section = $section;
|
||||
$this->priority = $priority;
|
||||
$this->message = $message;
|
||||
$this->args = $args;
|
||||
$this->time = time();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user