Create Addon and Theme classes

Create Addon and Theme classes and functions from plugin.php to appropriate class.

diff --git a/src/Core/Addon.php b/src/Core/Addon.php
new file mode 100644 (file)
index 0000000..f9a21d4
--- /dev/null
+++ b/src/Core/Addon.php
@@ -0,0 +1,300 @@
+<?php\r
+/**\r
+ * @file src/Core/Addon.php\r
+ */\r
+namespace Friendica\Core;\r
+\r
+use Friendica\App;\r
+use Friendica\Core\Config;\r
+use Friendica\Core\System;\r
+use Friendica\Database\DBM;\r
+\r
+/**\r
+ * Some functions to handle addons\r
+ */\r
+class Addon\r
+{\r
+    /**\r
+     * @brief uninstalls an addon.\r
+     *\r
+     * @param string $plugin name of the addon\r
+     * @return boolean\r
+     */\r
+    function uninstall_plugin($plugin) {\r
+        logger("Addons: uninstalling " . $plugin);\r
+        dba::delete('addon', ['name' => $plugin]);\r
+\r
+        @include_once('addon/' . $plugin . '/' . $plugin . '.php');\r
+        if (function_exists($plugin . '_uninstall')) {\r
+            $func = $plugin . '_uninstall';\r
+            $func();\r
+        }\r
+    }\r
+\r
+    /**\r
+     * @brief installs an addon.\r
+     *\r
+     * @param string $plugin name of the addon\r
+     * @return bool\r
+     */\r
+    function install_plugin($plugin) {\r
+        // silently fail if plugin was removed\r
+\r
+        if (!file_exists('addon/' . $plugin . '/' . $plugin . '.php')) {\r
+            return false;\r
+        }\r
+        logger("Addons: installing " . $plugin);\r
+        $t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');\r
+        @include_once('addon/' . $plugin . '/' . $plugin . '.php');\r
+        if (function_exists($plugin . '_install')) {\r
+            $func = $plugin . '_install';\r
+            $func();\r
+\r
+            $plugin_admin = (function_exists($plugin."_plugin_admin") ? 1 : 0);\r
+\r
+            dba::insert('addon', ['name' => $plugin, 'installed' => true,\r
+                        'timestamp' => $t, 'plugin_admin' => $plugin_admin]);\r
+\r
+            // we can add the following with the previous SQL\r
+            // once most site tables have been updated.\r
+            // This way the system won't fall over dead during the update.\r
+\r
+            if (file_exists('addon/' . $plugin . '/.hidden')) {\r
+                dba::update('addon', ['hidden' => true], ['name' => $plugin]);\r
+            }\r
+            return true;\r
+        } else {\r
+            logger("Addons: FAILED installing " . $plugin);\r
+            return false;\r
+        }\r
+    }\r
+\r
+    // reload all updated plugins\r
+\r
+    function reload_plugins() {\r
+        $plugins = Config::get('system', 'addon');\r
+        if (strlen($plugins)) {\r
+\r
+            $r = q("SELECT * FROM `addon` WHERE `installed` = 1");\r
+            if (DBM::is_result($r)) {\r
+                $installed = $r;\r
+            } else {\r
+                $installed = [];\r
+            }\r
+\r
+            $parr = explode(',',$plugins);\r
+\r
+            if (count($parr)) {\r
+                foreach ($parr as $pl) {\r
+\r
+                    $pl = trim($pl);\r
+\r
+                    $fname = 'addon/' . $pl . '/' . $pl . '.php';\r
+\r
+                    if (file_exists($fname)) {\r
+                        $t = @filemtime($fname);\r
+                        foreach ($installed as $i) {\r
+                            if (($i['name'] == $pl) && ($i['timestamp'] != $t)) {\r
+                                logger('Reloading plugin: ' . $i['name']);\r
+                                @include_once($fname);\r
+\r
+                                if (function_exists($pl . '_uninstall')) {\r
+                                    $func = $pl . '_uninstall';\r
+                                    $func();\r
+                                }\r
+                                if (function_exists($pl . '_install')) {\r
+                                    $func = $pl . '_install';\r
+                                    $func();\r
+                                }\r
+                                dba::update('addon', ['timestamp' => $t], ['id' => $i['id']]);\r
+                            }\r
+                        }\r
+                    }\r
+                }\r
+            }\r
+        }\r
+\r
+    }\r
+\r
+    /**\r
+     * @brief check if addon is enabled\r
+     *\r
+     * @param string $plugin\r
+     * @return boolean\r
+     */\r
+    function plugin_enabled($plugin) {\r
+        return dba::exists('addon', ['installed' => true, 'name' => $plugin]);\r
+    }\r
+\r
+\r
+    /**\r
+     * @brief registers a hook.\r
+     *\r
+     * @param string $hook the name of the hook\r
+     * @param string $file the name of the file that hooks into\r
+     * @param string $function the name of the function that the hook will call\r
+     * @param int $priority A priority (defaults to 0)\r
+     * @return mixed|bool\r
+     */\r
+    function register_hook($hook, $file, $function, $priority=0) {\r
+        $condition = ['hook' => $hook, 'file' => $file, 'function' => $function];\r
+        $exists = dba::exists('hook', $condition);\r
+        if ($exists) {\r
+            return true;\r
+        }\r
+\r
+        $r = dba::insert('hook', ['hook' => $hook, 'file' => $file, 'function' => $function, 'priority' => $priority]);\r
+\r
+        return $r;\r
+    }\r
+\r
+    /**\r
+     * @brief unregisters a hook.\r
+     *\r
+     * @param string $hook the name of the hook\r
+     * @param string $file the name of the file that hooks into\r
+     * @param string $function the name of the function that the hook called\r
+     * @return array\r
+     */\r
+    function unregister_hook($hook, $file, $function) {\r
+        $condition = ['hook' => $hook, 'file' => $file, 'function' => $function];\r
+        $r = dba::delete('hook', $condition);\r
+        return $r;\r
+    }\r
+\r
+\r
+    function load_hooks() {\r
+        $a = get_app();\r
+        $a->hooks = [];\r
+        $r = dba::select('hook', ['hook', 'file', 'function'], [], ['order' => ['priority' => 'desc', 'file']]);\r
+\r
+        while ($rr = dba::fetch($r)) {\r
+            if (! array_key_exists($rr['hook'],$a->hooks)) {\r
+                $a->hooks[$rr['hook']] = [];\r
+            }\r
+            $a->hooks[$rr['hook']][] = [$rr['file'],$rr['function']];\r
+        }\r
+        dba::close($r);\r
+    }\r
+\r
+    /**\r
+     * @brief Calls a hook.\r
+     *\r
+     * Use this function when you want to be able to allow a hook to manipulate\r
+     * the provided data.\r
+     *\r
+     * @param string $name of the hook to call\r
+     * @param string|array &$data to transmit to the callback handler\r
+     */\r
+    function call_hooks($name, &$data = null)\r
+    {\r
+        $a = get_app();\r
+\r
+        if (is_array($a->hooks) && array_key_exists($name, $a->hooks)) {\r
+            foreach ($a->hooks[$name] as $hook) {\r
+                call_single_hook($a, $name, $hook, $data);\r
+            }\r
+        }\r
+    }\r
+\r
+    /**\r
+     * @brief Calls a single hook.\r
+     *\r
+     * @param string $name of the hook to call\r
+     * @param array $hook Hook data\r
+     * @param string|array &$data to transmit to the callback handler\r
+     */\r
+    function call_single_hook($a, $name, $hook, &$data = null) {\r
+        // Don't run a theme's hook if the user isn't using the theme\r
+        if (strpos($hook[0], 'view/theme/') !== false && strpos($hook[0], 'view/theme/'.current_theme()) === false)\r
+            return;\r
+\r
+        @include_once($hook[0]);\r
+        if (function_exists($hook[1])) {\r
+            $func = $hook[1];\r
+            $func($a, $data);\r
+        } else {\r
+            // remove orphan hooks\r
+            $condition = ['hook' => $name, 'file' => $hook[0], 'function' => $hook[1]];\r
+            dba::delete('hook', $condition);\r
+        }\r
+    }\r
+\r
+    //check if an app_menu hook exist for plugin $name.\r
+    //Return true if the plugin is an app\r
+    function plugin_is_app($name) {\r
+        $a = get_app();\r
+\r
+        if (is_array($a->hooks) && (array_key_exists('app_menu',$a->hooks))) {\r
+            foreach ($a->hooks['app_menu'] as $hook) {\r
+                if ($hook[0] == 'addon/'.$name.'/'.$name.'.php')\r
+                    return true;\r
+            }\r
+        }\r
+\r
+        return false;\r
+    }\r
+\r
+    /**\r
+     * @brief Parse plugin comment in search of plugin infos.\r
+     *\r
+     * like\r
+     * \code\r
+     *...* Name: Plugin\r
+    *   * Description: A plugin which plugs in\r
+    * . * Version: 1.2.3\r
+    *   * Author: John <profile url>\r
+    *   * Author: Jane <email>\r
+    *   *\r
+    *  *\endcode\r
+    * @param string $plugin the name of the plugin\r
+    * @return array with the plugin information\r
+    */\r
+\r
+    function get_plugin_info($plugin) {\r
+\r
+        $a = get_app();\r
+\r
+        $info=[\r
+            'name' => $plugin,\r
+            'description' => "",\r
+            'author' => [],\r
+            'version' => "",\r
+            'status' => ""\r
+        ];\r
+\r
+        if (!is_file("addon/$plugin/$plugin.php")) return $info;\r
+\r
+        $stamp1 = microtime(true);\r
+        $f = file_get_contents("addon/$plugin/$plugin.php");\r
+        $a->save_timestamp($stamp1, "file");\r
+\r
+        $r = preg_match("|/\*.*\*/|msU", $f, $m);\r
+\r
+        if ($r) {\r
+            $ll = explode("\n", $m[0]);\r
+            foreach ( $ll as $l ) {\r
+                $l = trim($l,"\t\n\r */");\r
+                if ($l != "") {\r
+                    list($k,$v) = array_map("trim", explode(":",$l,2));\r
+                    $k= strtolower($k);\r
+                    if ($k == "author") {\r
+                        $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);\r
+                        if ($r) {\r
+                            $info['author'][] = ['name'=>$m[1], 'link'=>$m[2]];\r
+                        } else {\r
+                            $info['author'][] = ['name'=>$v];\r
+                        }\r
+                    } else {\r
+                        if (array_key_exists($k,$info)) {\r
+                            $info[$k]=$v;\r
+                        }\r
+                    }\r
+\r
+                }\r
+            }\r
+\r
+        }\r
+        return $info;\r
+    }\r
+}\r

diff --git a/src/Core/Theme.php b/src/Core/Theme.php
new file mode 100644 (file)
index 0000000..f08d48e
--- /dev/null
+++ b/src/Core/Theme.php
@@ -0,0 +1,187 @@
+<?php\r
+/**\r
+ * @file src/Core/Theme.php\r
+ */\r
+namespace Friendica\Core;\r
+\r
+use Friendica\App;\r
+use Friendica\Core\Config;\r
+use Friendica\Core\System;\r
+use Friendica\Database\DBM;\r
+\r
+/**\r
+ * Some functions to handle themes\r
+ */\r
+class Theme\r
+{\r
+    /**\r
+     * @brief Parse theme comment in search of theme infos.\r
+     *\r
+     * like\r
+     * \code\r
+     * ..* Name: My Theme\r
+     *   * Description: My Cool Theme\r
+     * . * Version: 1.2.3\r
+     *   * Author: John <profile url>\r
+     *   * Maintainer: Jane <profile url>\r
+     *   *\r
+     * \endcode\r
+     * @param string $theme the name of the theme\r
+     * @return array\r
+     */\r
+\r
+    function get_theme_info($theme) {\r
+        $info=[\r
+            'name' => $theme,\r
+            'description' => "",\r
+            'author' => [],\r
+            'maintainer' => [],\r
+            'version' => "",\r
+            'credits' => "",\r
+            'experimental' => false,\r
+            'unsupported' => false\r
+        ];\r
+\r
+        if (file_exists("view/theme/$theme/experimental"))\r
+            $info['experimental'] = true;\r
+        if (file_exists("view/theme/$theme/unsupported"))\r
+            $info['unsupported'] = true;\r
+\r
+        if (!is_file("view/theme/$theme/theme.php")) return $info;\r
+\r
+        $a = get_app();\r
+        $stamp1 = microtime(true);\r
+        $f = file_get_contents("view/theme/$theme/theme.php");\r
+        $a->save_timestamp($stamp1, "file");\r
+\r
+        $r = preg_match("|/\*.*\*/|msU", $f, $m);\r
+\r
+        if ($r) {\r
+            $ll = explode("\n", $m[0]);\r
+            foreach ( $ll as $l ) {\r
+                $l = trim($l,"\t\n\r */");\r
+                if ($l != "") {\r
+                    list($k,$v) = array_map("trim", explode(":",$l,2));\r
+                    $k= strtolower($k);\r
+                    if ($k == "author") {\r
+\r
+                        $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);\r
+                        if ($r) {\r
+                            $info['author'][] = ['name'=>$m[1], 'link'=>$m[2]];\r
+                        } else {\r
+                            $info['author'][] = ['name'=>$v];\r
+                        }\r
+                    } elseif ($k == "maintainer") {\r
+                        $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);\r
+                        if ($r) {\r
+                            $info['maintainer'][] = ['name'=>$m[1], 'link'=>$m[2]];\r
+                        } else {\r
+                            $info['maintainer'][] = ['name'=>$v];\r
+                        }\r
+                    } else {\r
+                        if (array_key_exists($k,$info)) {\r
+                            $info[$k]=$v;\r
+                        }\r
+                    }\r
+\r
+                }\r
+            }\r
+\r
+        }\r
+        return $info;\r
+    }\r
+\r
+    /**\r
+     * @brief Returns the theme's screenshot.\r
+     *\r
+     * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].\r
+     *\r
+     * @param sring $theme The name of the theme\r
+     * @return string\r
+     */\r
+    function get_theme_screenshot($theme) {\r
+        $exts = ['.png','.jpg'];\r
+        foreach ($exts as $ext) {\r
+            if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {\r
+                return(System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext);\r
+            }\r
+        }\r
+        return(System::baseUrl() . '/images/blank.png');\r
+    }\r
+\r
+    // install and uninstall theme\r
+    function uninstall_theme($theme) {\r
+        logger("Addons: uninstalling theme " . $theme);\r
+\r
+        include_once("view/theme/$theme/theme.php");\r
+        if (function_exists("{$theme}_uninstall")) {\r
+            $func = "{$theme}_uninstall";\r
+            $func();\r
+        }\r
+    }\r
+\r
+    function install_theme($theme) {\r
+        // silently fail if theme was removed\r
+\r
+        if (! file_exists("view/theme/$theme/theme.php")) {\r
+            return false;\r
+        }\r
+\r
+        logger("Addons: installing theme $theme");\r
+\r
+        include_once("view/theme/$theme/theme.php");\r
+\r
+        if (function_exists("{$theme}_install")) {\r
+            $func = "{$theme}_install";\r
+            $func();\r
+            return true;\r
+        } else {\r
+            logger("Addons: FAILED installing theme $theme");\r
+            return false;\r
+        }\r
+\r
+    }\r
+\r
+    /**\r
+     * @brief Get the full path to relevant theme files by filename\r
+     *\r
+     * This function search in the theme directory (and if not present in global theme directory)\r
+     * if there is a directory with the file extension and  for a file with the given\r
+     * filename.\r
+     *\r
+     * @param string $file Filename\r
+     * @param string $root Full root path\r
+     * @return string Path to the file or empty string if the file isn't found\r
+     */\r
+    function theme_include($file, $root = '') {\r
+        $file = basename($file);\r
+\r
+        // Make sure $root ends with a slash / if it's not blank\r
+        if ($root !== '' && $root[strlen($root)-1] !== '/') {\r
+            $root = $root . '/';\r
+        }\r
+        $theme_info = get_app()->theme_info;\r
+        if (is_array($theme_info) && array_key_exists('extends',$theme_info)) {\r
+            $parent = $theme_info['extends'];\r
+        } else {\r
+            $parent = 'NOPATH';\r
+        }\r
+        $theme = current_theme();\r
+        $thname = $theme;\r
+        $ext = substr($file,strrpos($file,'.')+1);\r
+        $paths = [\r
+            "{$root}view/theme/$thname/$ext/$file",\r
+            "{$root}view/theme/$parent/$ext/$file",\r
+            "{$root}view/$ext/$file",\r
+        ];\r
+        foreach ($paths as $p) {\r
+            // strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php)\r
+            if (strpos($p,'NOPATH') !== false) {\r
+                continue;\r
+            } elseif (file_exists($p)) {\r
+                return $p;\r
+            }\r
+        }\r
+        return '';\r
+    }\r
+}\r