badmanners/shimmie2
badmanners/shimmie2
Archived
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Proposed extension info change to allow getting info for unloaded extensions

Browse source
This commit is contained in:
Matthew Barbour 2019-08-01 11:20:09 -05:00 committed by matthew
parent e6411c32aa
commit 3d1b964812
9 changed files with 192 additions and 69 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
core/_bootstrap.php
View file

@ -26,6 +26,7 @@ $_tracer->begin("Opening files");
$_shm_files = array_merge(
zglob("core/*.php"),
zglob("core/{".ENABLED_MODS."}/*.php"),
zglob("ext/{".ENABLED_EXTS."}/info.php"),
zglob("ext/{".ENABLED_EXTS."}/main.php")
);
foreach ($_shm_files as $_shm_filename) {

61
core/extension.php
View file

@ -89,18 +89,26 @@ abstract class Extension
/** @var Themelet this theme's Themelet object */
public $theme;
public $info;
public function __construct()
{
$this->theme = $this->get_theme_object(get_called_class());
$class = get_called_class();
$this->theme = $this->get_theme_object($class);
$this->info = ExtensionInfo::get_for_extension($class);
}
public function is_live(): bool
public function is_supported(): bool
{
global $database;
return (
empty($this->db_support) ||
in_array($database->get_driver_name(), $this->db_support)
);
if($this->info!=null) {
return $this->info->supported;
} else {
global $database;
return (
empty($this->db_support) ||
in_array($database->get_driver_name(), $this->db_support)
);
}
}
/**
@ -130,6 +138,45 @@ abstract class Extension
}
}
abstract class ExtensionInfo
{
public $name;
public $authors;
public $link;
public $license;
public $version;
public $visibility;
public $description;
public $documentation;
public $supported;
public $db_support;
public function __construct()
{
$this->supported = $this->is_supported();
}
public function is_supported(): bool
{
global $database;
return (
empty($this->db_support) ||
in_array($database->get_driver_name(), $this->db_support)
);
}
public static function get_for_extension(string $base): ?ExtensionInfo
{
$normal = $base.'Info';
if (class_exists($normal)) {
return new $normal();
} else {
return null;
}
}
}
/**
* Class FormatterExtension
*

27
core/polyfills.php
View file

@ -801,4 +801,31 @@ function iterator_map(callable $callback, iterator $iter): Generator
function iterator_map_to_array(callable $callback, iterator $iter): array
{
return iterator_to_array(iterator_map($callback, $iter));
}
function get_class_from_file(string $file): string
{
$fp = fopen($file, 'r');
$class = $buffer = '';
$i = 0;
while (!$class) {
if (feof($fp)) break;
$buffer .= fread($fp, 512);
$tokens = token_get_all($buffer);
if (strpos($buffer, '{') === false) continue;
for (;$i<count($tokens);$i++) {
if ($tokens[$i][0] === T_CLASS) {
for ($j=$i+1;$j<count($tokens);$j++) {
if ($tokens[$j] === '{') {
$class = $tokens[$i+2][1];
}
}
}
}
}
return $class;
}

4
core/send_event.php
View file

@ -44,7 +44,7 @@ function _set_event_listeners(): void
$extension = new $class();
// skip extensions which don't support our current database
if (!$extension->is_live()) {
if (!$extension->is_supported()) {
continue;
}
@ -93,7 +93,7 @@ function ext_is_live(string $ext_name): bool
if (class_exists($ext_name)) {
/** @var Extension $ext */
$ext = new $ext_name();
return $ext->is_live();
return $ext->is_supported();
}
return false;
}

123
ext/ext_manager/main.php
View file

@ -12,12 +12,12 @@
* extensions and read their documentation
*/
function __extman_extcmp(ExtensionInfo $a, ExtensionInfo $b): int
function __extman_extcmp(ExtensionManagerInfo $a, ExtensionManagerInfo $b): int
{
return strcmp($a->name, $b->name);
}
class ExtensionInfo
class ExtensionManagerInfo
{
public $ext_name;
public $name;
@ -28,59 +28,88 @@ class ExtensionInfo
public $version;
public $visibility;
public $enabled;
public $supported;
public function __construct($main)
{
$matches = [];
$lines = file($main);
$number_of_lines = count($lines);
preg_match("#ext/(.*)/main.php#", $main, $matches);
$this->ext_name = $matches[1];
$this->name = $this->ext_name;
$this->enabled = $this->is_enabled($this->ext_name);
$this->authors = [];
for ($i = 0; $i < $number_of_lines; $i++) {
$line = $lines[$i];
if (preg_match("/Name: (.*)/", $line, $matches)) {
$this->name = $matches[1];
} elseif (preg_match("/Visibility: (.*)/", $line, $matches)) {
$this->visibility = $matches[1];
} elseif (preg_match("/Link: (.*)/", $line, $matches)) {
$this->link = $matches[1];
if ($this->link[0] == "/") {
$this->link = make_link(substr($this->link, 1));
}
} elseif (preg_match("/Version: (.*)/", $line, $matches)) {
$this->version = $matches[1];
} elseif (preg_match("/Authors?: (.*)/", $line, $matches)) {
$author_list = explode(',', $matches[1]);
foreach ($author_list as $author) {
if (preg_match("/(.*) [<\(](.*@.*)[>\)]/", $author, $matches)) {
$this->authors[] = new ExtensionAuthor($matches[1], $matches[2]);
} else {
$this->authors[] = new ExtensionAuthor($author, null);
if(file_exists("ext/{$this->ext_name}/info.php")) {
include_once "ext/{$this->ext_name}/info.php";
$class = get_class_from_file("ext/{$this->ext_name}/info.php");
$info = new $class();
$this->name = $info->name;
$this->link = $info->link;
foreach ($info->authors as $key=>$value){
$this->authors[] = new ExtensionAuthor($key, $value);
}
$this->description = $info->description;
$this->documentation = $info->documentation;
$this->version = $info->version;
$this->visibility = $info->visibility;
$this->supported = $info->supported;
} else {
$this->authors = [];
$handle = fopen($main, "r");
if ($handle === null) {
throw new Exception("Could not open extension file $main");
}
try {
$line = fgets($handle);
while ($line !== false) {
if (preg_match("/Name: (.*)/", $line, $matches)) {
$this->name = $matches[1];
} elseif (preg_match("/Visibility: (.*)/", $line, $matches)) {
$this->visibility = $matches[1];
} elseif (preg_match("/Link: (.*)/", $line, $matches)) {
$this->link = $matches[1];
if ($this->link[0] == "/") {
$this->link = make_link(substr($this->link, 1));
}
} elseif (preg_match("/Version: (.*)/", $line, $matches)) {
$this->version = $matches[1];
} elseif (preg_match("/Authors?: (.*)/", $line, $matches)) {
$author_list = explode(',', $matches[1]);
foreach ($author_list as $author) {
if (preg_match("/(.*) [<\(](.*@.*)[>\)]/", $author, $matches)) {
$this->authors[] = new ExtensionAuthor($matches[1], $matches[2]);
} else {
$this->authors[] = new ExtensionAuthor($author, null);
}
}
} elseif (preg_match("/(.*)Description: ?(.*)/", $line, $matches)) {
$this->description = $matches[2];
$start = $matches[1] . " ";
$start_len = strlen($start);
while (($line = fgets($handle)) !== false &&
substr($line, 0, $start_len) == $start) {
$this->description .= " " . substr($line, $start_len);
}
continue;
} elseif (preg_match("/(.*)Documentation: ?(.*)/", $line, $matches)) {
$this->documentation = $matches[2];
$start = $matches[1] . " ";
$start_len = strlen($start);
while (($line = fgets($handle)) !== false &&
substr($line, 0, $start_len) == $start) {
$this->documentation .= " " . substr($line, $start_len);
}
$this->documentation = str_replace('$site', make_http(get_base_href()), $this->documentation);
continue;
} elseif (preg_match("/\*\//", $line, $matches)) {
break;
}
$line = fgets($handle);
}
} elseif (preg_match("/(.*)Description: ?(.*)/", $line, $matches)) {
$this->description = $matches[2];
$start = $matches[1] . " ";
$start_len = strlen($start);
while (substr($lines[$i + 1], 0, $start_len) == $start) {
$this->description .= " " . substr($lines[$i + 1], $start_len);
$i++;
}
} elseif (preg_match("/(.*)Documentation: ?(.*)/", $line, $matches)) {
$this->documentation = $matches[2];
$start = $matches[1] . " ";
$start_len = strlen($start);
while (substr($lines[$i + 1], 0, $start_len) == $start) {
$this->documentation .= " " . substr($lines[$i + 1], $start_len);
$i++;
}
$this->documentation = str_replace('$site', make_http(get_base_href()), $this->documentation);
} elseif (preg_match("/\*\//", $line, $matches)) {
break;
} finally {
fclose($handle);
}
}
}
@ -142,8 +171,8 @@ class ExtManager extends Extension
if ($event->page_matches("ext_doc")) {
$ext = $event->get_arg(0);
if (file_exists("ext/$ext/main.php")) {
$info = new ExtensionInfo("ext/$ext/main.php");
if (file_exists("ext/$ext/info.php")) {
$info = new ExtensionManagerInfo("ext/$ext/main.php");
$this->theme->display_doc($page, $info);
} else {
$this->theme->display_table($page, $this->get_extensions(false), false);
@ -196,7 +225,7 @@ class ExtManager extends Extension
$exts = zglob("ext/{" . ENABLED_EXTS . "}/main.php");
}
foreach ($exts as $main) {
$extensions[] = new ExtensionInfo($main);
$extensions[] = new ExtensionManagerInfo($main);
}
usort($extensions, "__extman_extcmp");
return $extensions;

13
ext/ext_manager/theme.php
View file

@ -29,8 +29,13 @@ class ExtManagerTheme extends Themelet
$h_name = html_escape(empty($extension->name) ? $extension->ext_name : $extension->name);
$h_description = html_escape($extension->description);
$h_link = make_link("ext_doc/" . url_escape($extension->ext_name));
$h_enabled = ($extension->enabled === true ? " checked='checked'" : ($extension->enabled === false ? "" : " disabled checked='checked'"));
$h_enabled_box = $editable ? "<td><input type='checkbox' name='ext_" . html_escape($extension->ext_name) . "' id='ext_" . html_escape($extension->ext_name) . "'$h_enabled></td>" : "";
$h_enabled = ($extension->enabled === true ? " checked='checked'" : ($extension->enabled === false ? "" : " checked='checked'"));
$h_disabled = ($extension->supported===false || $extension->enabled===null? " disabled ": " " );
//baseline_open_in_new_black_18dp.png
$h_enabled_box = $editable ? "<td><input type='checkbox' name='ext_" . html_escape($extension->ext_name) . "' id='ext_" . html_escape($extension->ext_name) . "'$h_disabled $h_enabled></td>" : "";
$h_docs = ($extension->documentation ? "<a href='$h_link'>■</a>" : ""); //TODO: A proper "docs" symbol would be preferred here.
$html .= "
@ -38,7 +43,7 @@ class ExtManagerTheme extends Themelet
{$h_enabled_box}
<td><label for='ext_" . html_escape($extension->ext_name) . "'>{$h_name}</label></td>
<td>{$h_docs}</td>
<td style='text-align: left;'>{$h_description}</td>
<td style='text-align: left;'>{$h_description} " .($extension->supported===false ? "<b style='color:red'>Database not supported</b>" : ""). "</td>
</tr>";
}
$h_set = $editable ? "<tfoot><tr><td colspan='5'><input type='submit' value='Set Extensions'></td></tr></tfoot>" : "";
@ -113,7 +118,7 @@ class ExtManagerTheme extends Themelet
}
*/
public function display_doc(Page $page, ExtensionInfo $info)
public function display_doc(Page $page, ExtensionManagerInfo $info)
{
$author = "";
if (count($info->authors) > 0) {

22
ext/tips/info.php Normal file
View file

@ -0,0 +1,22 @@
<?php
/**
* Name: Random Tip
* Author: Sein Kraft <mail@seinkraft.info>
* License: GPLv2
* Description: Show a random line of text in the subheader space
* Documentation:
* Formatting is done with HTML
*/
class TipsInfo extends ExtensionInfo
{
public $key = "tips";
public $name = "Random Tip";
public $authors = ["Sein Kraft"=>"mail@seinkraft.info"];
public $license = "GPLv2";
public $description = "Show a random line of text in the subheader space";
public $documentation = "Formatting is done with HTML";
public $db_support = [DatabaseDriver::MYSQL, DatabaseDriver::SQLITE];
}

8
ext/tips/main.php
View file

@ -1,12 +1,4 @@
<?php
/**
* Name: Random Tip
* Author: Sein Kraft <mail@seinkraft.info>
* License: GPLv2
* Description: Show a random line of text in the subheader space
* Documentation:
* Formatting is done with HTML
*/
class Tips extends Extension
{

2
themes/danbooru2/ext_manager.theme.php
View file

@ -8,7 +8,7 @@ class CustomExtManagerTheme extends ExtManagerTheme
parent::display_table($page, $extensions, $editable);
}
public function display_doc(Page $page, ExtensionInfo $info)
public function display_doc(Page $page, ExtensionManagerInfo $info)
{
$page->disable_left();
parent::display_doc($page, $info);