require_once("include/friendica_smarty.php");
if(! function_exists('replace_macros')) {
+/**
+ * This is our template processor
+ *
+ * @global Template $t
+ * @param string|FriendicaSmarty $s the string requiring macro substitution,
+ * or an instance of FriendicaSmarty
+ * @param array $r key value pairs (search => replace)
+ * @return string substituted string
+ */
function replace_macros($s,$r) {
global $t;
-
+
$stamp1 = microtime(true);
$a = get_app();
return(substr($s,0,$size));
}}
+if(! function_exists('notags')) {
/**
* This is our primary input filter.
*
* They will be replaced with safer brackets. This may be filtered further
* if these are not allowed either.
*
+ * @param string $string Input string
+ * @return string Filtered string
*/
-
-if(! function_exists('notags')) {
function notags($string) {
return(str_replace(array("<",">"), array('[',']'), $string));
// return(str_replace(array("<",">","\xBA","\xBC","\xBE"), array('[',']','','',''), $string));
}}
-// use this on "body" or "content" input where angle chars shouldn't be removed,
-// and allow them to be safely displayed.
+
if(! function_exists('escape_tags')) {
+/**
+ * use this on "body" or "content" input where angle chars shouldn't be removed,
+ * and allow them to be safely displayed.
+ * @param string $string
+ * @return string
+ */
function escape_tags($string) {
return(htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false));
// used to generate initial passwords
if(! function_exists('autoname')) {
+/**
+ * generate a string that's random, but usually pronounceable.
+ * used to generate initial passwords
+ * @param int $len
+ * @return string
+ */
function autoname($len) {
if($len <= 0)
// returns escaped text.
if(! function_exists('xmlify')) {
+/**
+ * escape text ($str) for XML transport
+ * @param string $str
+ * @return string Escaped text.
+ */
function xmlify($str) {
/* $buffer = '';
return($buffer);
}}
-// undo an xmlify
-// pass xml escaped text ($s), returns unescaped text
-
if(! function_exists('unxmlify')) {
+/**
+ * undo an xmlify
+ * @param string $s xml escaped text
+ * @return string unescaped text
+ */
function unxmlify($s) {
// $ret = str_replace('&','&', $s);
// $ret = str_replace(array('<','>','"','''),array('<','>','"',"'"),$ret);
return $ret;
}}
-// convenience wrapper, reverse the operation "bin2hex"
-
if(! function_exists('hex2bin')) {
+/**
+ * convenience wrapper, reverse the operation "bin2hex"
+ * @param string $s
+ * @return number
+ */
function hex2bin($s) {
if(! (is_string($s) && strlen($s)))
return '';
return(pack("H*",$s));
}}
-// Automatic pagination.
-// To use, get the count of total items.
-// Then call $a->set_pager_total($number_items);
-// Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
-// Then call paginate($a) after the end of the display loop to insert the pager block on the page
-// (assuming there are enough items to paginate).
-// When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
-// will limit the results to the correct items for the current page.
-// The actual page handling is then accomplished at the application layer.
+
if(! function_exists('paginate')) {
+/**
+ * Automatic pagination.
+ *
+ * To use, get the count of total items.
+ * Then call $a->set_pager_total($number_items);
+ * Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
+ * Then call paginate($a) after the end of the display loop to insert the pager block on the page
+ * (assuming there are enough items to paginate).
+ * When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
+ * will limit the results to the correct items for the current page.
+ * The actual page handling is then accomplished at the application layer.
+ *
+ * @param App $a App instance
+ * @return string html for pagination #FIXME remove html
+ */
function paginate(&$a) {
$o = '';
$stripped = preg_replace('/(&page=[0-9]*)/','',$a->query_string);
}}
if(! function_exists('alt_pager')) {
+/**
+ * Alternative pager
+ * @param App $a App instance
+ * @param int $i
+ * @return string html for pagination #FIXME remove html
+ */
function alt_pager(&$a, $i) {
$o = '';
$stripped = preg_replace('/(&page=[0-9]*)/','',$a->query_string);
return $o;
}}
-// Turn user/group ACLs stored as angle bracketed text into arrays
if(! function_exists('expand_acl')) {
+/**
+ * Turn user/group ACLs stored as angle bracketed text into arrays
+ *
+ * @param string $s
+ * @return array
+ */
function expand_acl($s) {
// turn string array of angle-bracketed elements into numeric array
// e.g. "<1><2><3>" => array(1,2,3);
return $ret;
}}
-// Used to wrap ACL elements in angle brackets for storage
-
if(! function_exists('sanitise_acl')) {
+/**
+ * Wrap ACL elements in angle brackets for storage
+ * @param string $item
+ */
function sanitise_acl(&$item) {
if(intval($item))
$item = '<' . intval(notags(trim($item))) . '>';
}}
-// Convert an ACL array to a storable string
-// Normally ACL permissions will be an array.
-// We'll also allow a comma-separated string.
-
if(! function_exists('perms2str')) {
+/**
+ * Convert an ACL array to a storable string
+ *
+ * Normally ACL permissions will be an array.
+ * We'll also allow a comma-separated string.
+ *
+ * @param string|array $p
+ * @return string
+ */
function perms2str($p) {
$ret = '';
-
if(is_array($p))
$tmp = $p;
else
return $ret;
}}
-// generate a guaranteed unique (for this domain) item ID for ATOM
-// safe from birthday paradox
if(! function_exists('item_new_uri')) {
+/**
+ * generate a guaranteed unique (for this domain) item ID for ATOM
+ * safe from birthday paradox
+ *
+ * @param string $hostname
+ * @param int $uid
+ * @return string
+ */
function item_new_uri($hostname,$uid) {
do {
// safe from birthday paradox
if(! function_exists('photo_new_resource')) {
+/**
+ * Generate a guaranteed unique photo ID.
+ * safe from birthday paradox
+ *
+ * @return string
+ */
function photo_new_resource() {
do {
}}
-// wrapper to load a view template, checking for alternate
-// languages before falling back to the default
-
-// obsolete, deprecated.
-
if(! function_exists('load_view_file')) {
+/**
+ * @deprecated
+ * wrapper to load a view template, checking for alternate
+ * languages before falling back to the default
+ *
+ * @global string $lang
+ * @global App $a
+ * @param string $s view name
+ * @return string
+ */
function load_view_file($s) {
global $lang, $a;
if(! isset($lang))
}}
if(! function_exists('get_intltext_template')) {
+/**
+ * load a view template, checking for alternate
+ * languages before falling back to the default
+ *
+ * @global string $lang
+ * @param string $s view path
+ * @return string
+ */
function get_intltext_template($s) {
global $lang;
}}
if(! function_exists('get_markup_template')) {
+/**
+ * load template $s
+ *
+ * @param string $s
+ * @param string $root
+ * @return string
+ */
function get_markup_template($s, $root = '') {
$stamp1 = microtime(true);
}}
if(! function_exists("get_template_file")) {
+/**
+ *
+ * @param App $a
+ * @param string $filename
+ * @param string $root
+ * @return string
+ */
function get_template_file($a, $filename, $root = '') {
$theme = current_theme();
-// for html,xml parsing - let's say you've got
-// an attribute foobar="class1 class2 class3"
-// and you want to find out if it contains 'class3'.
-// you can't use a normal sub string search because you
-// might match 'notclass3' and a regex to do the job is
-// possible but a bit complicated.
-// pass the attribute string as $attr and the attribute you
-// are looking for as $s - returns true if found, otherwise false
+
if(! function_exists('attribute_contains')) {
+/**
+ * for html,xml parsing - let's say you've got
+ * an attribute foobar="class1 class2 class3"
+ * and you want to find out if it contains 'class3'.
+ * you can't use a normal sub string search because you
+ * might match 'notclass3' and a regex to do the job is
+ * possible but a bit complicated.
+ * pass the attribute string as $attr and the attribute you
+ * are looking for as $s - returns true if found, otherwise false
+ *
+ * @param string $attr attribute value
+ * @param string $s string to search
+ * @return boolean True if found, False otherwise
+ */
function attribute_contains($attr,$s) {
$a = explode(' ', $attr);
if(count($a) && in_array($s,$a))
}}
if(! function_exists('logger')) {
+/**
+ * log levels:
+ * LOGGER_NORMAL (default)
+ * LOGGER_TRACE
+ * LOGGER_DEBUG
+ * LOGGER_DATA
+ * LOGGER_ALL
+ *
+ * @global App $a
+ * @global dba $db
+ * @param string $msg
+ * @param int $level
+ */
function logger($msg,$level = 0) {
// turn off logger in install mode
global $a;
if(! function_exists('activity_match')) {
+/**
+ * Compare activity uri. Knows about activity namespace.
+ *
+ * @param string $haystack
+ * @param string $needle
+ * @return boolean
+ */
function activity_match($haystack,$needle) {
if(($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle,NAMESPACE_ACTIVITY_SCHEMA)))
return true;
}}
-// Pull out all #hashtags and @person tags from $s;
-// We also get @person@domain.com - which would make
-// the regex quite complicated as tags can also
-// end a sentence. So we'll run through our results
-// and strip the period from any tags which end with one.
-// Returns array of tags found, or empty array.
-
-
if(! function_exists('get_tags')) {
+/**
+ * Pull out all #hashtags and @person tags from $s;
+ * We also get @person@domain.com - which would make
+ * the regex quite complicated as tags can also
+ * end a sentence. So we'll run through our results
+ * and strip the period from any tags which end with one.
+ * Returns array of tags found, or empty array.
+ *
+ * @param string $s
+ * @return array
+ */
function get_tags($s) {
$ret = array();
}}
-// quick and dirty quoted_printable encoding
+//
if(! function_exists('qp')) {
+/**
+ * quick and dirty quoted_printable encoding
+ *
+ * @param string $s
+ * @return string
+ */
function qp($s) {
return str_replace ("%","=",rawurlencode($s));
}}
if(! function_exists('get_mentions')) {
+/**
+ * @param array $item
+ * @return string html for mentions #FIXME: remove html
+ */
function get_mentions($item) {
$o = '';
if(! strlen($item['tag']))
}}
if(! function_exists('contact_block')) {
+/**
+ * Get html for contact block.
+ *
+ * @template contact_block.tpl
+ * @hook contact_block_end (contacts=>array, output=>string)
+ * @return string
+ */
function contact_block() {
$o = '';
$a = get_app();
}}
if(! function_exists('micropro')) {
+/**
+ *
+ * @param array $contact
+ * @param boolean $redirect
+ * @param string $class
+ * @param boolean $textmode
+ * @return string #FIXME: remove html
+ */
function micropro($contact, $redirect = false, $class = '', $textmode = false) {
if($class)
if(! function_exists('search')) {
+/**
+ * search box
+ *
+ * @param string $s search query
+ * @param string $id html id
+ * @param string $url search url
+ * @param boolean $save show save search button
+ * @return string html for search box #FIXME: remove html
+ */
function search($s,$id='search-box',$url='/search',$save = false) {
$a = get_app();
$o = '<div id="' . $id . '">';
}}
if(! function_exists('valid_email')) {
+/**
+ * Check if $x is a valid email string
+ *
+ * @param string $x
+ * @return boolean
+ */
function valid_email($x){
if(get_config('system','disable_email_validation'))
}}
+if(! function_exists('linkify')) {
/**
- *
- * Function: linkify
- *
* Replace naked text hyperlink with HTML formatted hyperlink
*
+ * @param string $s
*/
-
-if(! function_exists('linkify')) {
function linkify($s) {
$s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\'\%\$\!\+]*)/", ' <a href="$1" target="external-link">$1</a>', $s);
$s = preg_replace("/\<(.*?)(src|href)=(.*?)\&\;(.*?)\>/ism",'<$1$2=$3&$4>',$s);
return($s);
}}
+
+/**
+ * Load poke verbs
+ *
+ * @return array index is present tense verb
+ value is array containing past tense verb, translation of present, translation of past
+ * @hook poke_verbs pokes array
+ */
function get_poke_verbs() {
// index is present tense verb
return $arr;
}
+/**
+ * Load moods
+ * @return array index is mood, value is translated mood
+ * @hook mood_verbs moods array
+ */
function get_mood_verbs() {
- // index is present tense verb
- // value is array containing past tense verb, translation of present, translation of past
-
$arr = array(
'happy' => t('happy'),
'sad' => t('sad'),
}
+
+if(! function_exists('smilies')) {
/**
- *
- * Function: smilies
- *
- * Description:
* Replaces text emoticons with graphical images
*
- * @Parameter: string $s
- *
- * Returns string
- *
* It is expected that this function will be called using HTML text.
* We will escape text between HTML pre and code blocks from being
* processed.
* function from being executed by the prepare_text() routine when preparing
* bbcode source for HTML display
*
+ * @param string $s
+ * @param boolean $sample
+ * @return string
+ * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array, 'string' => $s)
*/
-
-if(! function_exists('smilies')) {
function smilies($s, $sample = false) {
-
$a = get_app();
if(intval(get_config('system','no_smilies'))
return(str_replace($m[1],base64url_decode($m[1]),$m[0]));
}
-// expand <3333 to the correct number of hearts
+/**
+ * expand <3333 to the correct number of hearts
+ *
+ * @param string $x
+ * @return string
+ */
function preg_heart($x) {
$a = get_app();
if(strlen($x[1]) == 1)
if(! function_exists('day_translate')) {
+/**
+ * Translate days and months names
+ *
+ * @param string $s
+ * @return string
+ */
function day_translate($s) {
$ret = str_replace(array('Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'),
array( t('Monday'), t('Tuesday'), t('Wednesday'), t('Thursday'), t('Friday'), t('Saturday'), t('Sunday')),
if(! function_exists('normalise_link')) {
+/**
+ * Normalize url
+ *
+ * @param string $url
+ * @return string
+ */
function normalise_link($url) {
$ret = str_replace(array('https:','//www.'), array('http:','//'), $url);
return(rtrim($ret,'/'));
}}
+
+
+if(! function_exists('link_compare')) {
/**
- *
* Compare two URLs to see if they are the same, but ignore
* slight but hopefully insignificant differences such as if one
* is https and the other isn't, or if one is www.something and
* the other isn't - and also ignore case differences.
*
- * Return true if the URLs match, otherwise false.
+ * @param string $a first url
+ * @param string $b second url
+ * @return boolean True if the URLs match, otherwise False
*
- */
-
-if(! function_exists('link_compare')) {
+ */
function link_compare($a,$b) {
if(strcasecmp(normalise_link($a),normalise_link($b)) === 0)
return true;
}}
-// Find any non-embedded images in private items and add redir links to them
-
if(! function_exists('redir_private_images')) {
+/**
+ * Find any non-embedded images in private items and add redir links to them
+ *
+ * @param App $a
+ * @param array $item
+ */
function redir_private_images($a, &$item) {
$matches = false;
// If attach is true, also add icons for item attachments
if(! function_exists('prepare_body')) {
+/**
+ * Given an item array, convert the body element from bbcode to html and add smilie icons.
+ * If attach is true, also add icons for item attachments
+ *
+ * @param array $item
+ * @param boolean $attach
+ * @return string item body html
+ * @hook prepare_body_init item array before any work
+ * @hook prepare_body ('item'=>item array, 'html'=>body string) after first bbcode to html
+ * @hook prepare_body_final ('item'=>item array, 'html'=>body string) after attach icons and blockquote special case handling (spoiler, author)
+ */
function prepare_body($item,$attach = false) {
$a = get_app();
}}
-// Given a text string, convert from bbcode to html and add smilie icons.
-
if(! function_exists('prepare_text')) {
+/**
+ * Given a text string, convert from bbcode to html and add smilie icons.
+ *
+ * @param string $text
+ * @return string
+ */
function prepare_text($text) {
require_once('include/bbcode.php');
}}
+
/**
- * returns
- * [
- * //categories [
+ * return array with details for categories and folders for an item
+ *
+ * @param array $item
+ * @return array
+ *
+ * [
+ * [ // categories array
* {
* 'name': 'category name',
- * 'removeurl': 'url to remove this category',
- * 'first': 'is the first in this array? true/false',
+ * 'removeurl': 'url to remove this category',
+ * 'first': 'is the first in this array? true/false',
* 'last': 'is the last in this array? true/false',
* } ,
* ....
* ],
- * // folders [
+ * [ //folders array
+ * {
* 'name': 'folder name',
* 'removeurl': 'url to remove this folder',
* 'first': 'is the first in this array? true/false',
* } ,
* ....
* ]
- * ]
+ * ]
*/
function get_cats_and_terms($item) {
+
$a = get_app();
$categories = array();
$folders = array();
}
+
+if(! function_exists('feed_hublinks')) {
/**
* return atom link elements for all of our hubs
+ * @return string hub link xml elements
*/
-
-if(! function_exists('feed_hublinks')) {
function feed_hublinks() {
$hub = get_config('system','huburl');
return $hubxml;
}}
-/* return atom link elements for salmon endpoints */
if(! function_exists('feed_salmonlinks')) {
+/**
+ * return atom link elements for salmon endpoints
+ * @param string $nick user nickname
+ * @return string salmon link xml elements
+ */
function feed_salmonlinks($nick) {
$a = get_app();
}}
if(! function_exists('get_plink')) {
+/**
+ * get private link for item
+ * @param array $item
+ * @return boolean|array False if item has not plink, otherwise array('href'=>plink url, 'title'=>translated title)
+ */
function get_plink($item) {
$a = get_app();
if (x($item,'plink') && ($item['private'] != 1)) {
}}
if(! function_exists('unamp')) {
+/**
+ * replace html amp entity with amp char
+ * @param string $s
+ * @return string
+ */
function unamp($s) {
return str_replace('&', '&', $s);
}}
if(! function_exists('lang_selector')) {
+/**
+ * get html for language selector
+ * @global string $lang
+ * @return string
+ * @template lang_selector.tpl
+ */
function lang_selector() {
global $lang;
if(! function_exists('return_bytes')) {
+/**
+ * return number of bytes in size (K, M, G)
+ * @param string $size_str
+ * @return number
+ */
function return_bytes ($size_str) {
switch (substr ($size_str, -1))
{
}
}}
+/**
+ * @return string
+ */
function generate_user_guid() {
$found = true;
do {
}
-
+/**
+ * @param string $s
+ * @param boolean $strip_padding
+ * @return string
+ */
function base64url_encode($s, $strip_padding = false) {
$s = strtr(base64_encode($s),'+/','-_');
return $s;
}
+/**
+ * @param string $s
+ * @return string
+ */
function base64url_decode($s) {
if(is_array($s)) {
projects / friendica.git / commitdiff