harukin/core
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Extend documentation.

Browse Source
This commit is contained in:
Klaus Weidenbach
2019-01-26 00:47:39 +01:00
parent 671b6d2eda
commit 728788e3b9
4 changed files with 267 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

321
Zotlabs/Lib/Apps.php
View File

@@ -1,32 +1,34 @@
<?php /** @file */
<?php
namespace Zotlabs\Lib;
/**
* Apps
*
*/
require_once('include/plugin.php');
require_once('include/channel.php');
/**
* @brief Apps class.
*
*/
class Apps {
static public $available_apps = null;
static public $installed_apps = null;
static public $base_apps = null;
/**
* @brief
*
* @param boolean $translate (optional) default true
* @return array
*/
static public function get_system_apps($translate = true) {
$ret = [];
$ret = array();
if(is_dir('apps'))
$files = glob('apps/*.apd');
else
$files = glob('app/*.apd');
if($files) {
foreach($files as $f) {
$x = self::parse_app_description($f,$translate);
@@ -50,10 +52,13 @@ class Apps {
}
}
call_hooks('get_system_apps',$ret);
/**
* @hooks get_system_apps
* Hook to manipulate the system apps array.
*/
call_hooks('get_system_apps', $ret);
return $ret;
}
static public function get_base_apps() {
@@ -72,7 +77,13 @@ class Apps {
'Mail',
'Profile Photo'
]);
call_hooks('get_base_apps',$x);
/**
* @hooks get_base_apps
* Hook to manipulate the base apps array.
*/
call_hooks('get_base_apps', $x);
return $x;
}
@@ -106,6 +117,7 @@ class Apps {
// $id will be boolean true or false to install an app, or an integer id to update an existing app
if($id === false)
continue;
if($id !== true) {
// if we already installed this app, but it changed, preserve any categories we created
$s = EMPTY_STR;
@@ -126,7 +138,6 @@ class Apps {
$app['guid'] = hash('whirlpool',$app['name']);
$app['system'] = 1;
self::app_install(local_channel(),$app);
}
}
}
@@ -134,8 +145,10 @@ class Apps {
/**
* Install the system app if no system apps have been installed, or if a new system app
* is discovered, or if the version of a system app changes.
*
* @param array $app
* @return boolean|int
*/
static public function check_install_system_app($app) {
if((! is_array(self::$available_apps)) || (! count(self::$available_apps))) {
return true;
@@ -159,14 +172,13 @@ class Apps {
return $notfound;
}
/**
* Install the system app if no system apps have been installed, or if a new system app
* is discovered, or if the version of a system app changes.
* Install the personal app if no personal apps have been installed, or if a new personal app
* is discovered, or if the version of a personal app changes.
*
* @param array $app
* @return boolean|int
*/
static public function check_install_personal_app($app) {
$installed = false;
foreach(self::$installed_apps as $iapp) {
@@ -189,20 +201,25 @@ class Apps {
return strcasecmp($a['name'],$b['name']);
}
static public function parse_app_description($f,$translate = true) {
$ret = array();
/**
* @brief Parse app description.
*
* @param string $f filename
* @param boolean $translate (optional) default true
* @return boolean|array
*/
static public function parse_app_description($f, $translate = true) {
$ret = [];
$matches = [];
$baseurl = z_root();
$channel = \App::get_channel();
$address = (($channel) ? $channel['channel_address'] : '');
//$channel = \App::get_channel();
//$address = (($channel) ? $channel['channel_address'] : '');
//future expansion
$observer = \App::get_observer();
$lines = @file($f);
if($lines) {
foreach($lines as $x) {
@@ -292,8 +309,10 @@ class Apps {
if($ret) {
if($translate)
self::translate_system_apps($ret);
return $ret;
}
return false;
}
@@ -371,25 +390,26 @@ class Apps {
}
}
}
}
// papp is a portable app
static public function app_render($papp,$mode = 'view') {
/**
* modes:
* view: normal mode for viewing an app via bbcode from a conversation or page
* @brief
*
* @param array $papp
* papp is a portable app
* @param string $mode (optional) default 'view'
* Render modes:
* * \b view: normal mode for viewing an app via bbcode from a conversation or page
* provides install/update button if you're logged in locally
* install: like view but does not display app-bin options if they are present
* list: normal mode for viewing an app on the app page
* * \b install: like view but does not display app-bin options if they are present
* * \b list: normal mode for viewing an app on the app page
* no buttons are shown
* edit: viewing the app page in editing mode provides a delete button
* nav: render apps for app-bin
* * \b edit: viewing the app page in editing mode provides a delete button
* * \b nav: render apps for app-bin
*
* @return void|string Parsed HTML
*/
static public function app_render($papp, $mode = 'view') {
$installed = false;
if(! $papp)
@@ -427,7 +447,6 @@ class Apps {
$papp['url'] = z_root() . ((strpos($papp['url'],'/') === 0) ? '' : '/') . $papp['url'];
foreach($papp as $k => $v) {
if(strpos($v,'http') === 0 && $k != 'papp') {
if(! (local_channel() && strpos($v,z_root()) === 0)) {
@@ -592,8 +611,14 @@ class Apps {
return false;
}
static public function can_delete($uid,$app) {
/**
* @brief
*
* @param mixed $uid If not set return false, otherwise no influence
* @param array $app
* @return boolean
*/
static public function can_delete($uid, $app) {
if(! $uid) {
return false;
}
@@ -601,7 +626,7 @@ class Apps {
$base_apps = self::get_base_apps();
if($base_apps) {
foreach($base_apps as $b) {
if($app['guid'] === hash('whirlpool',$b)) {
if($app['guid'] === hash('whirlpool', $b)) {
return false;
}
}
@@ -613,7 +638,6 @@ class Apps {
static public function app_destroy($uid,$app) {
if($uid && $app['guid']) {
$x = q("select * from app where app_id = '%s' and app_channel = %d limit 1",
dbesc($app['guid']),
intval($uid)
@@ -622,7 +646,7 @@ class Apps {
if(! intval($x[0]['app_deleted'])) {
$x[0]['app_deleted'] = 1;
if(self::can_delete($uid,$app)) {
$r = q("delete from app where app_id = '%s' and app_channel = %d",
q("delete from app where app_id = '%s' and app_channel = %d",
dbesc($app['guid']),
intval($uid)
);
@@ -630,10 +654,15 @@ class Apps {
intval(TERM_OBJ_APP),
intval($x[0]['id'])
);
/**
* @hooks app_destroy
* Called after app entry got removed from database
* and provide app array from database.
*/
call_hooks('app_destroy', $x[0]);
}
else {
$r = q("update app set app_deleted = 1 where app_id = '%s' and app_channel = %d",
q("update app set app_deleted = 1 where app_id = '%s' and app_channel = %d",
dbesc($app['guid']),
intval($uid)
);
@@ -647,22 +676,23 @@ class Apps {
}
}
}
}
static public function app_undestroy($uid,$app) {
// undelete a system app
/**
* @brief Undelete a system app.
*
* @param int $uid
* @param array $app
*/
static public function app_undestroy($uid, $app) {
if($uid && $app['guid']) {
$x = q("select * from app where app_id = '%s' and app_channel = %d limit 1",
dbesc($app['guid']),
intval($uid)
);
if($x) {
if($x[0]['app_system']) {
$r = q("update app set app_deleted = 0 where app_id = '%s' and app_channel = %d",
q("update app set app_deleted = 0 where app_id = '%s' and app_channel = %d",
dbesc($app['guid']),
intval($uid)
);
@@ -671,7 +701,15 @@ class Apps {
}
}
static public function app_feature($uid,$app,$term) {
/**
* @brief
*
* @param int $uid
* @param array $app
* @param string $term
* @return void
*/
static public function app_feature($uid, $app, $term) {
$r = q("select id from app where app_id = '%s' and app_channel = %d limit 1",
dbesc($app['guid']),
intval($uid)
@@ -695,23 +733,37 @@ class Apps {
}
}
static public function app_installed($uid,$app,$bypass_filter=false) {
/**
* @brief
*
* @param int $uid
* @param array $app
* @param boolean $bypass_filter (optional) default false
* @return boolean
*/
static public function app_installed($uid, $app, $bypass_filter = false) {
$r = q("select id from app where app_id = '%s' and app_channel = %d limit 1",
dbesc((array_key_exists('guid',$app)) ? $app['guid'] : ''),
dbesc((array_key_exists('guid', $app)) ? $app['guid'] : ''),
intval($uid)
);
if (!$bypass_filter) {
if(!$bypass_filter) {
$filter_arr = [
'uid'=>$uid,
'app'=>$app,
'installed'=>$r
'uid' => $uid,
'app' => $app,
'installed' => $r
];
call_hooks('app_installed_filter',$filter_arr);
/**
* @hooks app_installed_filter
* * \e int \b uid
* * \e array \b app
* * \e mixed \b installed - return value
*/
call_hooks('app_installed_filter', $filter_arr);
$r = $filter_arr['installed'];
}
return(($r) ? true : false);
return(($r) ? true : false);
}
@@ -727,11 +779,17 @@ class Apps {
'app'=>$app,
'installed'=>$r
];
call_hooks('addon_app_installed_filter',$filter_arr);
/**
* @hooks addon_app_installed_filter
* * \e int \b uid
* * \e array \b app
* * \e mixed \b installed - return value
*/
call_hooks('addon_app_installed_filter', $filter_arr);
$r = $filter_arr['installed'];
}
return(($r) ? true : false);
return(($r) ? true : false);
}
static public function system_app_installed($uid,$app,$bypass_filter=false) {
@@ -746,28 +804,39 @@ class Apps {
'app'=>$app,
'installed'=>$r
];
call_hooks('system_app_installed_filter',$filter_arr);
/**
* @hooks system_app_installed_filter
* * \e int \b uid
* * \e array \b app
* * \e mixed \b installed - return value
*/
call_hooks('system_app_installed_filter', $filter_arr);
$r = $filter_arr['installed'];
}
return(($r) ? true : false);
return(($r) ? true : false);
}
/**
* @brief
*
* @param int $uid
* @param boolean $deleted
* @param array $cats
* @return boolean|array
*/
static public function app_list($uid, $deleted = false, $cats = []) {
if($deleted)
$sql_extra = "";
$sql_extra = '';
else
$sql_extra = " and app_deleted = 0 ";
$sql_extra = ' and app_deleted = 0 ';
if($cats) {
$cat_sql_extra = " and ( ";
$cat_sql_extra = ' and ( ';
foreach($cats as $cat) {
if(strpos($cat_sql_extra, 'term'))
$cat_sql_extra .= "or ";
$cat_sql_extra .= 'or ';
$cat_sql_extra .= "term = '" . dbesc($cat) . "' ";
}
@@ -779,11 +848,13 @@ class Apps {
);
if(! $r)
return $r;
$sql_extra .= " and app.id in ( ";
$sql_extra .= ' and app.id in ( ';
$s = '';
foreach($r as $rr) {
if($s)
$s .= ',';
$s .= intval($rr['oid']);
}
$sql_extra .= $s . ') ';
@@ -794,12 +865,26 @@ class Apps {
);
if($r) {
$hookinfo = Array('uid'=>$uid,'deleted'=>$deleted,'cats'=>$cats,'apps'=>$r);
call_hooks('app_list',$hookinfo);
$hookinfo = [
'uid' => $uid,
'deleted' => $deleted,
'cats' => $cats,
'apps' => $r,
];
/**
* @hooks app_list
* * \e int \b uid
* * \e boolean \b deleted
* * \e array \b cats
* * \e array \b apps - return value
*/
call_hooks('app_list', $hookinfo);
$r = $hookinfo['apps'];
for($x = 0; $x < count($r); $x ++) {
for($x = 0; $x < count($r); $x++) {
if(! $r[$x]['app_system'])
$r[$x]['type'] = 'personal';
$r[$x]['term'] = q("select * from term where otype = %d and oid = %d",
intval(TERM_OBJ_APP),
intval($r[$x]['id'])
@@ -807,7 +892,7 @@ class Apps {
}
}
return($r);
return $r;
}
static public function app_order($uid,$apps,$menu) {
@@ -839,13 +924,14 @@ class Apps {
$ret[] = $ap;
}
}
return $ret;
return $ret;
}
static function find_app_in_array($name,$arr) {
if(! $arr)
return false;
foreach($arr as $x) {
if($x['name'] === $name) {
return $x;
@@ -854,8 +940,16 @@ class Apps {
return false;
}
static function moveup($uid,$guid,$menu) {
$syslist = array();
/**
* @brief
*
* @param int $uid
* @param int $guid
* @param string $menu
* @return void
*/
static function moveup($uid, $guid, $menu) {
$syslist = [];
$conf = (($menu === 'nav_featured_app') ? 'app_order' : 'app_pin_order');
@@ -865,6 +959,7 @@ class Apps {
$papp = self::app_encode($li);
if($menu !== 'nav_pinned_app' && strpos($papp['categories'],'nav_pinned_app') !== false)
continue;
$syslist[] = $papp;
}
}
@@ -877,8 +972,6 @@ class Apps {
if(! $syslist)
return;
$newlist = [];
foreach($syslist as $k => $li) {
if($li['guid'] === $guid) {
$position = $k;
@@ -887,6 +980,7 @@ class Apps {
}
if(! $position)
return;
$dest_position = $position - 1;
$saved = $syslist[$dest_position];
$syslist[$dest_position] = $syslist[$position];
@@ -898,11 +992,18 @@ class Apps {
}
set_pconfig($uid,'system',$conf,implode(',',$narr));
}
static function movedown($uid,$guid,$menu) {
$syslist = array();
/**
* @brief
*
* @param int $uid
* @param int $guid
* @param string $menu
* @return void
*/
static function movedown($uid, $guid, $menu) {
$syslist = [];
$conf = (($menu === 'nav_featured_app') ? 'app_order' : 'app_pin_order');
@@ -912,6 +1013,7 @@ class Apps {
$papp = self::app_encode($li);
if($menu !== 'nav_pinned_app' && strpos($papp['categories'],'nav_pinned_app') !== false)
continue;
$syslist[] = $papp;
}
}
@@ -924,8 +1026,6 @@ class Apps {
if(! $syslist)
return;
$newlist = [];
foreach($syslist as $k => $li) {
if($li['guid'] === $guid) {
$position = $k;
@@ -934,6 +1034,7 @@ class Apps {
}
if($position >= count($syslist) - 1)
return;
$dest_position = $position + 1;
$saved = $syslist[$dest_position];
$syslist[$dest_position] = $syslist[$position];
@@ -945,7 +1046,6 @@ class Apps {
}
set_pconfig($uid,'system',$conf,implode(',',$narr));
}
static public function app_decode($s) {
@@ -953,8 +1053,14 @@ class Apps {
return json_decode($x,true);
}
static public function app_macros($uid,&$arr) {
/**
* @brief
*
* @param int $uid
* @param[in,out] array $arr
* @return void
*/
static public function app_macros($uid, &$arr) {
if(! intval($uid))
return;
@@ -965,18 +1071,14 @@ class Apps {
//future expansion
$observer = \App::get_observer();
//$observer = \App::get_observer();
$arr['url'] = str_replace(array('$baseurl','$nick'),array($baseurl,$address),$arr['url']);
$arr['photo'] = str_replace(array('$baseurl','$nick'),array($baseurl,$address),$arr['photo']);
}
static public function app_store($arr) {
//logger('app_store: ' . print_r($arr,true));
@@ -1160,13 +1262,17 @@ class Apps {
}
return $ret;
}
static public function app_encode($app,$embed = false) {
$ret = array();
/**
* @brief
*
* @param array $app
* @param boolean $embed (optional) default false
* @return array|string
*/
static public function app_encode($app, $embed = false) {
$ret = [];
$ret['type'] = 'personal';
@@ -1226,12 +1332,12 @@ class Apps {
foreach($app['term'] as $t) {
if($s)
$s .= ',';
$s .= $t['term'];
}
$ret['categories'] = $s;
}
if(! $embed)
return $ret;
@@ -1241,16 +1347,13 @@ class Apps {
unset($ret['categories']);
$j = json_encode($ret);
return '[app]' . chunk_split(base64_encode($j),72,"\n") . '[/app]';
return '[app]' . chunk_split(base64_encode($j),72,"\n") . '[/app]';
}
static public function papp_encode($papp) {
return chunk_split(base64_encode(json_encode($papp)),72,"\n");
}
}

8
Zotlabs/Module/Notes.php
View File

@@ -1,10 +1,13 @@
<?php
namespace Zotlabs\Module; /** @file */
namespace Zotlabs\Module;
use App;
use Zotlabs\Web\Controller;
use Zotlabs\Lib\Apps;
/**
* @brief Notes Module controller.
*/
class Notes extends Controller {
function post() {
@@ -40,11 +43,9 @@ class Notes extends Controller {
logger('notes saved.', LOGGER_DEBUG);
json_return_and_die($ret);
}
function get() {
if(! local_channel())
return EMPTY_STR;
@@ -61,7 +62,6 @@ class Notes extends Controller {
$arr = ['app' => true];
return $w->widget($arr);
}
}

22
include/contact_widgets.php
View File

@@ -9,7 +9,7 @@ function findpeople_widget() {
if($x || is_site_admin()) {
App::$page['aside'] .= '<div class="side-link" id="side-invite-remain">'
. sprintf( tt('%d invitation available','%d invitations available',$x), $x)
. '</div>' . $inv;
. '</div>';
}
}
@@ -22,7 +22,7 @@ function findpeople_widget() {
'$hint' => t('Examples: Robert Morgenstein, Fishing'),
'$findthem' => t('Find'),
'$suggest' => t('Channel Suggestions'),
'$similar' => '', // FIXME and uncomment when mod/match working // t('Similar Interests'),
'$similar' => '', /// @FIXME fixme and uncomment when mod/match working // t('Similar Interests'),
'$random' => t('Random Profile'),
'$inv' => t('Invite Friends'),
'$advanced_search' => $advanced_search,
@@ -56,7 +56,6 @@ function fileas_widget($baseurl,$selected = '') {
'$all' => t('Everything'),
'$terms' => $terms,
'$base' => $baseurl,
));
}
@@ -100,7 +99,6 @@ function categories_widget($baseurl,$selected = '') {
'$all' => t('Everything'),
'$terms' => $terms,
'$base' => $baseurl,
));
}
return '';
@@ -144,9 +142,9 @@ function cardcategories_widget($baseurl,$selected = '') {
'$all' => t('Everything'),
'$terms' => $terms,
'$base' => $baseurl,
));
}
return '';
}
@@ -189,17 +187,14 @@ function articlecategories_widget($baseurl,$selected = '') {
'$all' => t('Everything'),
'$terms' => $terms,
'$base' => $baseurl,
));
}
return '';
}
function common_friends_visitor_widget($profile_uid,$cnt = 25) {
if(local_channel() == $profile_uid)
@@ -219,16 +214,13 @@ function common_friends_visitor_widget($profile_uid,$cnt = 25) {
$r = common_friends($profile_uid,$observer_hash,0,$cnt,true);
return replace_macros(get_markup_template('remote_friends_common.tpl'), array(
return replace_macros(get_markup_template('remote_friends_common.tpl'), [
'$desc' => t('Common Connections'),
'$base' => z_root(),
'$uid' => $profile_uid,
'$cid' => $observer,
'$linkmore' => (($t > $cnt) ? 'true' : ''),
'$more' => sprintf( t('View all %d common connections'), $t),
'$items' => $r
));
'$items' => $r,
]);
};

3
view/tpl/remote_friends_common.tpl
View File

@@ -7,10 +7,9 @@
<div class="contact-block-content">
{{foreach $items as $item}}
<div class="contact-block-div">
<a class="contact-block-link mpfriend" href="{{$base}}/chanview?f=&url={{$item.xchan_url}}"><img class="contact-block-img mpfriend" src="{{$item.xchan_photo_s}}"alt="{{$item.xchan_name}}" title="{{$item.xchan_name}} [{{$item.xchan_addr}}]" /></a>
<a class="contact-block-link mpfriend" href="{{$base}}/chanview?f=&url={{$item.xchan_url}}"><img class="contact-block-img mpfriend" src="{{$item.xchan_photo_s}}" alt="{{$item.xchan_name}}" title="{{$item.xchan_name}} [{{$item.xchan_addr}}]" /></a>
</div>
{{/foreach}}
</div>
{{/if}}
</div>