<?php
/**
* @file include/plugin.php
- *
+ *
* @brief Some functions to handle addons and themes.
*/
+use Friendica\App;
+use Friendica\Core\Config;
+use Friendica\Core\System;
+use Friendica\Database\DBM;
/**
* @brief uninstalls an addon.
* @param string $plugin name of the addon
* @return boolean
*/
-if (! function_exists('uninstall_plugin')){
-function uninstall_plugin($plugin){
+function uninstall_plugin($plugin) {
logger("Addons: uninstalling " . $plugin);
- q("DELETE FROM `addon` WHERE `name` = '%s' ",
- dbesc($plugin)
- );
+ dba::delete('addon', array('name' => $plugin));
@include_once('addon/' . $plugin . '/' . $plugin . '.php');
- if(function_exists($plugin . '_uninstall')) {
+ if (function_exists($plugin . '_uninstall')) {
$func = $plugin . '_uninstall';
$func();
}
-}}
+}
/**
* @brief installs an addon.
* @param string $plugin name of the addon
* @return bool
*/
-if (! function_exists('install_plugin')){
function install_plugin($plugin) {
// silently fail if plugin was removed
- if(! file_exists('addon/' . $plugin . '/' . $plugin . '.php'))
+ if (!file_exists('addon/' . $plugin . '/' . $plugin . '.php')) {
return false;
+ }
logger("Addons: installing " . $plugin);
$t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
@include_once('addon/' . $plugin . '/' . $plugin . '.php');
- if(function_exists($plugin . '_install')) {
+ if (function_exists($plugin . '_install')) {
$func = $plugin . '_install';
$func();
- $plugin_admin = (function_exists($plugin."_plugin_admin")?1:0);
+ $plugin_admin = (function_exists($plugin."_plugin_admin") ? 1 : 0);
- $r = q("INSERT INTO `addon` (`name`, `installed`, `timestamp`, `plugin_admin`) VALUES ( '%s', 1, %d , %d ) ",
- dbesc($plugin),
- intval($t),
- $plugin_admin
- );
+ dba::insert('addon', array('name' => $plugin, 'installed' => true,
+ 'timestamp' => $t, 'plugin_admin' => $plugin_admin));
// we can add the following with the previous SQL
// once most site tables have been updated.
// This way the system won't fall over dead during the update.
- if(file_exists('addon/' . $plugin . '/.hidden')) {
- q("UPDATE `addon` SET `hidden` = 1 WHERE `name` = '%s'",
- dbesc($plugin)
- );
+ if (file_exists('addon/' . $plugin . '/.hidden')) {
+ dba::update('addon', array('hidden' => true), array('name' => $plugin));
}
return true;
- }
- else {
+ } else {
logger("Addons: FAILED installing " . $plugin);
return false;
}
-
-}}
+}
// reload all updated plugins
-if(! function_exists('reload_plugins')) {
function reload_plugins() {
- $plugins = get_config('system','addon');
- if(strlen($plugins)) {
+ $plugins = Config::get('system', 'addon');
+ if (strlen($plugins)) {
$r = q("SELECT * FROM `addon` WHERE `installed` = 1");
- if (dbm::is_result($r))
+ if (DBM::is_result($r)) {
$installed = $r;
- else
+ } else {
$installed = array();
+ }
$parr = explode(',',$plugins);
- if(count($parr)) {
- foreach($parr as $pl) {
+ if (count($parr)) {
+ foreach ($parr as $pl) {
$pl = trim($pl);
$fname = 'addon/' . $pl . '/' . $pl . '.php';
- if(file_exists($fname)) {
+ if (file_exists($fname)) {
$t = @filemtime($fname);
- foreach($installed as $i) {
- if(($i['name'] == $pl) && ($i['timestamp'] != $t)) {
+ foreach ($installed as $i) {
+ if (($i['name'] == $pl) && ($i['timestamp'] != $t)) {
logger('Reloading plugin: ' . $i['name']);
@include_once($fname);
- if(function_exists($pl . '_uninstall')) {
+ if (function_exists($pl . '_uninstall')) {
$func = $pl . '_uninstall';
$func();
}
- if(function_exists($pl . '_install')) {
+ if (function_exists($pl . '_install')) {
$func = $pl . '_install';
$func();
}
- q("UPDATE `addon` SET `timestamp` = %d WHERE `id` = %d",
- intval($t),
- intval($i['id'])
- );
+ dba::update('addon', array('timestamp' => $t), array('id' => $i['id']));
}
}
}
}
}
-}}
+}
/**
* @brief check if addon is enabled
* @return boolean
*/
function plugin_enabled($plugin) {
- $r = q("SELECT * FROM `addon` WHERE `installed` = 1 AND `name` = '%s'", $plugin);
- return ((dbm::is_result($r)) && (count($r) > 0));
+ return dba::exists('addon', array('installed' => true, 'name' => $plugin));
}
* @param int $priority A priority (defaults to 0)
* @return mixed|bool
*/
-if(! function_exists('register_hook')) {
-function register_hook($hook,$file,$function,$priority=0) {
-
- $r = q("SELECT * FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s' LIMIT 1",
- dbesc($hook),
- dbesc($file),
- dbesc($function)
- );
- if (dbm::is_result($r))
+function register_hook($hook, $file, $function, $priority=0) {
+ $condition = array('hook' => $hook, 'file' => $file, 'function' => $function);
+ $exists = dba::exists('hook', $condition);
+ if ($exists) {
return true;
+ }
+
+ $r = dba::insert('hook', array('hook' => $hook, 'file' => $file, 'function' => $function, 'priority' => $priority));
- $r = q("INSERT INTO `hook` (`hook`, `file`, `function`, `priority`) VALUES ( '%s', '%s', '%s', '%s' ) ",
- dbesc($hook),
- dbesc($file),
- dbesc($function),
- dbesc($priority)
- );
return $r;
-}}
+}
/**
* @brief unregisters a hook.
- *
+ *
* @param string $hook the name of the hook
* @param string $file the name of the file that hooks into
* @param string $function the name of the function that the hook called
* @return array
*/
-if(! function_exists('unregister_hook')) {
-function unregister_hook($hook,$file,$function) {
-
- $r = q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s'",
- dbesc($hook),
- dbesc($file),
- dbesc($function)
- );
+function unregister_hook($hook, $file, $function) {
+ $condition = array('hook' => $hook, 'file' => $file, 'function' => $function);
+ $r = dba::delete('hook', $condition);
return $r;
-}}
+}
-if(! function_exists('load_hooks')) {
function load_hooks() {
$a = get_app();
$a->hooks = array();
- $r = q("SELECT * FROM `hook` WHERE 1 ORDER BY `priority` DESC, `file`");
+ $r = dba::select('hook', array('hook', 'file', 'function'), array(), array('order' => array('priority' => 'desc', 'file')));
- if (dbm::is_result($r)) {
- foreach ($r as $rr) {
- if(! array_key_exists($rr['hook'],$a->hooks))
- $a->hooks[$rr['hook']] = array();
- $a->hooks[$rr['hook']][] = array($rr['file'],$rr['function']);
+ while ($rr = dba::fetch($r)) {
+ if (! array_key_exists($rr['hook'],$a->hooks)) {
+ $a->hooks[$rr['hook']] = array();
}
+ $a->hooks[$rr['hook']][] = array($rr['file'],$rr['function']);
}
-}}
+ dba::close($r);
+}
/**
* @brief Calls a hook.
$func($a, $data);
} else {
// remove orphan hooks
- q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s'",
- dbesc($name),
- dbesc($hook[0]),
- dbesc($hook[1])
- );
+ $condition = array('hook' => $name, 'file' => $hook[0], 'function' => $hook[1]);
+ dba::delete('hook', $condition);
}
}
//check if an app_menu hook exist for plugin $name.
//Return true if the plugin is an app
-if(! function_exists('plugin_is_app')) {
function plugin_is_app($name) {
$a = get_app();
- if(is_array($a->hooks) && (array_key_exists('app_menu',$a->hooks))) {
- foreach($a->hooks['app_menu'] as $hook) {
- if($hook[0] == 'addon/'.$name.'/'.$name.'.php')
+ if (is_array($a->hooks) && (array_key_exists('app_menu',$a->hooks))) {
+ foreach ($a->hooks['app_menu'] as $hook) {
+ if ($hook[0] == 'addon/'.$name.'/'.$name.'.php')
return true;
}
}
return false;
-}}
+}
/**
* @brief Parse plugin comment in search of plugin infos.
* @return array with the plugin information
*/
-if (! function_exists('get_plugin_info')){
-function get_plugin_info($plugin){
+function get_plugin_info($plugin) {
$a = get_app();
$r = preg_match("|/\*.*\*/|msU", $f, $m);
- if ($r){
+ if ($r) {
$ll = explode("\n", $m[0]);
- foreach( $ll as $l ) {
+ foreach ( $ll as $l ) {
$l = trim($l,"\t\n\r */");
- if ($l!=""){
+ if ($l != "") {
list($k,$v) = array_map("trim", explode(":",$l,2));
$k= strtolower($k);
- if ($k=="author"){
+ if ($k == "author") {
$r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
if ($r) {
$info['author'][] = array('name'=>$m[1], 'link'=>$m[2]);
$info['author'][] = array('name'=>$v);
}
} else {
- if (array_key_exists($k,$info)){
+ if (array_key_exists($k,$info)) {
$info[$k]=$v;
}
}
}
return $info;
-}}
+}
/**
* @brief Parse theme comment in search of theme infos.
- *
+ *
* like
* \code
* ..* Name: My Theme
* @return array
*/
-if (! function_exists('get_theme_info')){
-function get_theme_info($theme){
+function get_theme_info($theme) {
$info=Array(
'name' => $theme,
'description' => "",
'unsupported' => false
);
- if(file_exists("view/theme/$theme/experimental"))
+ if (file_exists("view/theme/$theme/experimental"))
$info['experimental'] = true;
- if(file_exists("view/theme/$theme/unsupported"))
+ if (file_exists("view/theme/$theme/unsupported"))
$info['unsupported'] = true;
if (!is_file("view/theme/$theme/theme.php")) return $info;
$r = preg_match("|/\*.*\*/|msU", $f, $m);
- if ($r){
+ if ($r) {
$ll = explode("\n", $m[0]);
- foreach( $ll as $l ) {
+ foreach ( $ll as $l ) {
$l = trim($l,"\t\n\r */");
- if ($l!=""){
+ if ($l != "") {
list($k,$v) = array_map("trim", explode(":",$l,2));
$k= strtolower($k);
- if ($k=="author"){
+ if ($k == "author") {
$r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
if ($r) {
} else {
$info['author'][] = array('name'=>$v);
}
- }
- elseif ($k=="maintainer"){
+ } elseif ($k == "maintainer") {
$r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
if ($r) {
$info['maintainer'][] = array('name'=>$m[1], 'link'=>$m[2]);
$info['maintainer'][] = array('name'=>$v);
}
} else {
- if (array_key_exists($k,$info)){
+ if (array_key_exists($k,$info)) {
$info[$k]=$v;
}
}
}
return $info;
-}}
+}
/**
* @brief Returns the theme's screenshot.
*/
function get_theme_screenshot($theme) {
$exts = array('.png','.jpg');
- foreach($exts as $ext) {
- if(file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {
- return(App::get_baseurl() . '/view/theme/' . $theme . '/screenshot' . $ext);
+ foreach ($exts as $ext) {
+ if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {
+ return(System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext);
}
}
- return(App::get_baseurl() . '/images/blank.png');
+ return(System::baseUrl() . '/images/blank.png');
}
// install and uninstall theme
-if (! function_exists('uninstall_theme')){
-function uninstall_theme($theme){
+function uninstall_theme($theme) {
logger("Addons: uninstalling theme " . $theme);
- @include_once("view/theme/$theme/theme.php");
- if(function_exists("{$theme}_uninstall")) {
+ include_once("view/theme/$theme/theme.php");
+ if (function_exists("{$theme}_uninstall")) {
$func = "{$theme}_uninstall";
$func();
}
-}}
+}
-if (! function_exists('install_theme')){
function install_theme($theme) {
// silently fail if theme was removed
- if(! file_exists("view/theme/$theme/theme.php"))
+ if (! file_exists("view/theme/$theme/theme.php")) {
return false;
+ }
logger("Addons: installing theme $theme");
- @include_once("view/theme/$theme/theme.php");
+ include_once("view/theme/$theme/theme.php");
- if(function_exists("{$theme}_install")) {
+ if (function_exists("{$theme}_install")) {
$func = "{$theme}_install";
$func();
return true;
- }
- else {
+ } else {
logger("Addons: FAILED installing theme $theme");
return false;
}
-}}
-
-
-
-// check service_class restrictions. If there are no service_classes defined, everything is allowed.
-// if $usage is supplied, we check against a maximum count and return true if the current usage is
-// less than the subscriber plan allows. Otherwise we return boolean true or false if the property
-// is allowed (or not) in this subscriber plan. An unset property for this service plan means
-// the property is allowed, so it is only necessary to provide negative properties for each plan,
-// or what the subscriber is not allowed to do.
-
-
-function service_class_allows($uid,$property,$usage = false) {
-
- if($uid == local_user()) {
- $service_class = $a->user['service_class'];
- }
- else {
- $r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
- intval($uid)
- );
- if (dbm::is_result($r)) {
- $service_class = $r[0]['service_class'];
- }
- }
- if(! x($service_class))
- return true; // everything is allowed
-
- $arr = get_config('service_class',$service_class);
- if(! is_array($arr) || (! count($arr)))
- return true;
-
- if($usage === false)
- return ((x($arr[$property])) ? (bool) $arr['property'] : true);
- else {
- if(! array_key_exists($property,$arr))
- return true;
- return (((intval($usage)) < intval($arr[$property])) ? true : false);
- }
-}
-
-
-function service_class_fetch($uid,$property) {
-
- if($uid == local_user()) {
- $service_class = $a->user['service_class'];
- }
- else {
- $r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
- intval($uid)
- );
- if (dbm::is_result($r)) {
- $service_class = $r[0]['service_class'];
- }
- }
- if(! x($service_class))
- return false; // everything is allowed
-
- $arr = get_config('service_class',$service_class);
- if(! is_array($arr) || (! count($arr)))
- return false;
-
- return((array_key_exists($property,$arr)) ? $arr[$property] : false);
-
-}
-
-function upgrade_link($bbcode = false) {
- $l = get_config('service_class','upgrade_link');
- if(! $l)
- return '';
- if($bbcode)
- $t = sprintf('[url=%s]' . t('Click here to upgrade.') . '[/url]', $l);
- else
- $t = sprintf('<a href="%s">' . t('Click here to upgrade.') . '</div>', $l);
- return $t;
-}
-
-function upgrade_message($bbcode = false) {
- $x = upgrade_link($bbcode);
- return t('This action exceeds the limits set by your subscription plan.') . (($x) ? ' ' . $x : '') ;
-}
-
-function upgrade_bool_message($bbcode = false) {
- $x = upgrade_link($bbcode);
- return t('This action is not available under your subscription plan.') . (($x) ? ' ' . $x : '') ;
}
/**
* @brief Get the full path to relevant theme files by filename
- *
+ *
* This function search in the theme directory (and if not present in global theme directory)
* if there is a directory with the file extension and for a file with the given
- * filename.
- *
+ * filename.
+ *
* @param string $file Filename
* @param string $root Full root path
* @return string Path to the file or empty string if the file isn't found
*/
function theme_include($file, $root = '') {
+ $file = basename($file);
+
// Make sure $root ends with a slash / if it's not blank
- if($root !== '' && $root[strlen($root)-1] !== '/')
+ if ($root !== '' && $root[strlen($root)-1] !== '/') {
$root = $root . '/';
- $theme_info = $a->theme_info;
- if(is_array($theme_info) AND array_key_exists('extends',$theme_info))
+ }
+ $theme_info = get_app()->theme_info;
+ if (is_array($theme_info) && array_key_exists('extends',$theme_info)) {
$parent = $theme_info['extends'];
- else
+ } else {
$parent = 'NOPATH';
+ }
$theme = current_theme();
$thname = $theme;
$ext = substr($file,strrpos($file,'.')+1);
"{$root}view/theme/$parent/$ext/$file",
"{$root}view/$ext/$file",
);
- foreach($paths as $p) {
+ foreach ($paths as $p) {
// strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php)
- if(strpos($p,'NOPATH') !== false)
+ if (strpos($p,'NOPATH') !== false) {
continue;
- if(file_exists($p))
+ } elseif (file_exists($p)) {
return $p;
+ }
}
return '';
}