# The Red Matrix: include/text.php File Reference

All Classes Namespaces Files Functions Variables Pages
text.php File Reference

## Functions

| replace_macros ($s, $r)
| random_string ($size=64, $type=RANDOM_STRING_HEX)
| notags ($string)
| escape_tags ($string)
| z_input_filter ($channel_id, $s, $type= 'text/bbcode')
| purify_html ($s)
| autoname ($len)
| xmlify ($str)
| unxmlify ($s)
if(!function_exists('hex2bin')) | paginate (&$a)
| alt_pager (&$a, $i, $more= '', $less= '')
| expand_acl ($s)
| sanitise_acl (&$item)
| perms2str ($p)
| item_message_id ()
| photo_new_resource ()
| attribute_contains ($attr, $s)
| logger ($msg, $level=0)
| dlogger ($msg, $level=0)
| profiler ($t1, $t2, $label)
| activity_match ($haystack, $needle)
| get_tags ($s)
| qp ($s)
| get_mentions ($item, $tags)
| contact_block ()
| chanlink_hash ($s)
| chanlink_url ($s)
| chanlink_cid ($d)
| magiclink_url ($observer, $myaddr, $url)
| micropro ($contact, $redirect=false, $class= '', $textmode=false)
| search ($s, $id='search-box', $url='/search', $save=false)
| searchbox ($s, $id='search-box', $url='/search', $save=false)
| valid_email ($x)
| linkify ($s)
| sslify ($s)
| get_poke_verbs ()
| get_mood_verbs ()
| smilies ($s, $sample=false)
| smile_shield ($m)
| smile_unshield ($m)
| preg_heart ($x)
| day_translate ($s)
| normalise_link ($url)
| link_compare ($a, $b)
| unobscure (&$item)
| theme_attachments (&$item)
| format_categories (&$item, $writeable)
| format_filer (&$item)
| prepare_body (&$item, $attach=false)
| prepare_text ($text, $content_type= 'text/bbcode')
| zidify_callback ($match)
| zidify_img_callback ($match)
| zidify_links ($s)
| feed_hublinks ()
| feed_salmonlinks ($nick)
| get_plink ($item, $conversation_mode=true)
| unamp ($s)
| layout_select ($channel_id, $current= '')
| mimetype_select ($channel_id, $current= 'text/bbcode')
| lang_selector ()
| return_bytes ($size_str)
| base64url_encode ($s, $strip_padding=true)
| base64url_decode ($s)
| cleardiv ()
| bb_translate_video ($s)
| html2bb_video ($s)
| array_xmlify ($val)
| reltoabs ($text, $base)
| item_post_type ($item)
| undo_post_tagging ($s)
| fix_mce_lf ($s)
| protect_sprintf ($s)
| is_a_date_arg ($s)
| legal_webbie ($s)
| check_webbie ($arr)
| ids_to_querystr ($arr, $idx= 'id')
| xchan_query (&$items, $abook=true)
| xchan_mail_query (&$item)
| find_xchan_in_array ($xchan, $arr)
| get_rel_link ($j, $rel)
| magic_link ($s)
| stringify_array_elms (&$arr, $escape=false)
| jindent ($json)
| json_decode_plus ($s)
| design_tools ()
| in_arrayi ($needle, $haystack)

## Variables

const | RANDOM_STRING_HEX 0x00
const | RANDOM_STRING_TEXT 0x01

## Function Documentation

activity_match | ( |  | $haystack,
|  |  | $needle
| ) |  |

Referenced by Item\add_child(), Conversation\add_thread(), consume_feed(), conversation(), get_atom_elements(), item_post_type(), like_puller(), localize_item(), process_delivery(), remove_community_tag(), and visible_activity().

alt_pager | ( | & | $a,
|  |  | $i,
|  |  | $more = `''`,
|  |  | $less = `''`
| ) |  |

Referenced by channel_content(), community_content(), directory_content(), message_content(), and network_content().

array_xmlify | ( |  | $val | ) |

apply xmlify() to all values of array $val, recursively

Referenced by api_apply_template(), and poco_init().

attribute_contains | ( |  | $attr,
|  |  | $s
| ) |  |

autoname | ( |  | $len | ) |

generate a string that's random, but usually pronounceable. used to generate initial passwords

Parameters

  int | $len |

Returns
  string

Referenced by check_php(), invite_post(), and lostpass_content().

base64url_decode | ( |  | $s | ) |

Referenced by aes_unencapsulate(), get_atom_elements(), get_item_elements(), import_post(), import_site(), import_xchan(), oembed_init(), post_init(), post_post(), smile_unshield(), zfinger_init(), and zot_register_hub().

base64url_encode | ( |  | $s,
|  |  | $strip_padding = `true`
| ) |  |

Referenced by aes_encapsulate(), allowed_public_recips(), create_identity(), fix_system_urls(), get_item_elements(), identity_basic_export(), import_author_zot(), import_post(), import_xchan(), item_post(), item_store(), item_store_update(), magic_init(), oembed_iframe(), post_activity_item(), post_post(), random_string(), smile_shield(), zfinger_init(), zot_build_packet(), zot_fetch(), zot_import(), zot_new_uid(), and zot_register_hub().

bb_translate_video | ( |  | $s | ) |

Referenced by item_post().

chanlink_cid | ( |  | $d | ) |

chanlink_hash | ( |  | $s | ) |

Referenced by mail_content(), message_content(), and micropro().

chanlink_url | ( |  | $s | ) |

Referenced by Item\check_wall_to_wall(), directory_content(), dirprofile_init(), fetch_post_tags(), Item\get_template_data(), localize_item(), randprof_init(), suggest_content(), and widget_suggestions().

check_webbie | ( |  | $arr | ) |

Referenced by create_identity(), and new_channel_init().

cleardiv | ( |  | ) |

Referenced by common_content(), and match_content().

contact_block | ( |  | ) |

Referenced by profile_sidebar().

day_translate | ( |  | $s | ) |

Referenced by advanced_profile(), cal(), events_content(), format_event_diaspora(), format_event_html(), get_birthdays(), get_events(), ping_init(), and posted_dates().

design_tools | ( |  | ) |

Referenced by widget_design_tools().

dlogger | ( |  | $msg,
|  |  | $level = `0`
| ) |  |

escape_tags | ( |  | $string | ) |

use this on "body" or "content" input where angle chars shouldn't be removed, and allow them to be safely displayed.

Parameters

  string | $string |

Returns
  string

Referenced by admin_page_logs(), chatsvc_post(), connect_post(), create_identity(), events_post(), fsuggest_post(), get_atom_elements(), item_post(), item_store(), mail_post(), mail_store(), menu_add_item(), menu_create(), menu_edit(), menu_edit_item(), network_content(), notes_init(), printable(), profiles_post(), thing_init(), and z_input_filter().

expand_acl | ( |  | $s | ) |

Referenced by collect_recipients(), enumerate_permissions(), and lockview_content().

feed_hublinks | ( |  | ) |

return atom link elements for all of our hubs

feed_salmonlinks | ( |  | $nick | ) |

find_xchan_in_array | ( |  | $xchan,
|  |  | $arr
| ) |  |

Referenced by private_messages_fetch_conversation(), private_messages_fetch_message(), private_messages_list(), xchan_mail_query(), and xchan_query().

fix_mce_lf | ( |  | $s | ) |

Referenced by item_post(), mail_post(), and profiles_post().

format_categories | ( | & | $item,
|  |  | $writeable
| ) |  |

Referenced by prepare_body().

format_filer | ( | & | $item | ) |

Referenced by prepare_body().

get_mentions | ( |  | $item,
|  |  | $tags
| ) |  |

get_mood_verbs | ( |  | ) |

Referenced by mood_content(), and mood_init().

get_plink | ( |  | $item,
|  |  | $conversation_mode = `true`
| ) |  |

Referenced by conversation(), and Item\get_template_data().

get_poke_verbs | ( |  | ) |

Referenced by poke_content(), and poke_init().

get_rel_link | ( |  | $j,
|  |  | $rel
| ) |  |

Referenced by localize_item(), remove_community_tag(), and tag_deliver().

get_tags | ( |  | $s | ) |

Referenced by item_post(), and photos_post().

html2bb_video | ( |  | $s | ) |

Referenced by api_statuses_mediap(), api_statuses_update(), and get_atom_elements().

ids_to_querystr | ( |  | $arr,
|  |  | $idx = `'id'`
| ) |  |

Referenced by channel_content(), display_content(), items_fetch(), network_content(), and zot_feed().

in_arrayi | ( |  | $needle,
|  |  | $haystack
| ) |  |

Referenced by dirprofile_init(), and import_directory_profile().

is_a_date_arg | ( |  | $s | ) |

Referenced by channel_content(), and network_content().

item_message_id | ( |  | ) |

Referenced by event_store(), item_post(), like_content(), mood_init(), photo_upload(), photos_create_item(), post_activity_item(), profile_activity(), and subthread_content().

item_post_type | ( |  | $item | ) |

Referenced by notification().

jindent | ( |  | $json | ) |

Indents a flat JSON string to make it more human-readable.

Parameters

  string | $json | The original JSON string to process.

Returns
  string Indented version of the original JSON string.

json_decode_plus | ( |  | $s | ) |

Referenced by editpost_content(), editwebpage_content(), encode_item(), encode_mail(), localize_item(), private_messages_fetch_conversation(), private_messages_fetch_message(), private_messages_list(), remove_community_tag(), tag_deliver(), theme_attachments(), and unobscure().

lang_selector | ( |  | ) |

Referenced by nav().

layout_select | ( |  | $channel_id,
|  |  | $current = `''`
| ) |  |

Referenced by editwebpage_content().

legal_webbie | ( |  | $s | ) |

Referenced by check_webbie(), and new_channel_init().

link_compare | ( |  | $a,
|  |  | $b
| ) |  |

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.

Referenced by consume_feed(), like_puller(), tag_deliver(), tgroup_check(), and zid().

linkify | ( |  | $s | ) |

Function: linkify

Replace naked text hyperlink with HTML formatted hyperlink

Referenced by advanced_profile(), dirprofile_init(), and profile_activity().

logger | ( |  | $msg,
|  |  | $level = `0`
| ) |  |

Referenced by RedDirectory\__construct(), RedFile\__construct(), account_remove(), account_verify_password(), Item\add_child(), Conversation\add_thread(), admin_content(), admin_page_hubloc_post(), admin_post(), advanced_profile(), aes_encapsulate(), allowed_public_recips(), api_call(), api_channel_stream(), api_export_basic(), api_favorites(), api_get_user(), api_login(), api_oauth_request_token(), api_statuses_destroy(), api_statuses_mediap(), api_statuses_repeat(), api_statuses_show(), api_statuses_update(), api_statuses_user_timeline(), attach_mkdir(), avatar_img(), base64url_decode(), blog_install(), blog_uninstall(), bookmark_add(), bookmarks_init(), build_sync_packet(), chanman_remove_everything_from_network(), channel_remove(), chanview_content(), check_config(), check_form_security_token_ForbiddenOnErr(), check_form_security_token_redirectOnErr(), RedDirectory\childExists(), cloud_init(), consume_feed(), conversation(), create_account(), create_identity(), RedDirectory\createDirectory(), RedDirectory\createFile(), cronhooks_run(), datetime_convert(), delete_imported_item(), deliver_run(), detect_language(), directory_content(), directory_run(), dirprofile_init(), email_send(), encode_item(), expire_run(), feed_init(), fetch_lrdd_template(), filer_content(), filerm_content(), fix_private_photos(), fix_system_urls(), RedFile\get(), get_atom_elements(), get_item_elements(), Conversation\get_template_data(), RedDirectory\getChild(), RedDirectory\getDir(), RedDirectory\getName(), RedFile\getName(), group_content(), guess_image_type(), head_set_icon(), http_status_exit(), import_author_zot(), import_channel_photo(), import_directory_profile(), import_post(), import_profile_photo(), import_site(), import_xchan(), install_plugin(), item_expire(), item_post(), item_store(), item_store_update(), like_content(), limit_body_size(), load_plugin(), localize_item(), FKOAuth1\loginUser(), FKOAuthDataStore\lookup_consumer(), FKOAuthDataStore\lookup_token(), magic_init(), mail_post(), mail_store(), menu_edit(), mini_group_select(), mood_init(), FKOAuthDataStore\new_access_token(), new_contact(), new_keypair(), FKOAuthDataStore\new_request_token(), notes_init(), notification(), notifier_run(), onedirsync_run(), onepoll_run(), parse_url_content(), parse_xml_string(), photo_init(), photo_upload(), photos_post(), ping_init(), poco_init(), poco_load(), poke_init(), poller_run(), post_activity_item(), post_init(), post_post(), private_messages_list(), process_channel_sync_delivery(), process_delivery(), process_mail_delivery(), process_profile_delivery(), profile_load(), profile_sidebar(), public_recips(), RedFile\put(), dba_mysql\q(), dba_mysqli\q(), q(), queue_run(), RedCollectionData(), RedFileData(), register_content(), reload_plugins(), Item\remove_child(), remove_community_tag(), remove_queue_item(), scale_external_images(), search_ac_init(), enotify\send(), send_reg_approval_email(), Conversation\set_mode(), RedFile\setName(), stream_perms_api_uids(), stream_perms_xchans(), subthread_content(), sync_directories(), syncdirs(), tag_deliver(), tagger_content(), tgroup_check(), uninstall_plugin(), unload_plugin(), update_directory_entry(), update_imported_item(), update_queue_time(), RedBasicAuth\validateUserPass(), webfinger(), webfinger_dfrn(), xml2array(), xml_status(), z_fetch_url(), z_post_url(), zfinger_init(), zid_init(), zot_build_packet(), zot_feed(), zot_fetch(), zot_finger(), zot_gethub(), zot_import(), zot_process_response(), zot_refresh(), zot_register_hub(), and zotfeed_init().

magic_link | ( |  | $s | ) |

magiclink_url | ( |  | $observer,
|  |  | $myaddr,
|  |  | $url
| ) |  |

Referenced by item_redir_and_replace_images().

micropro | ( |  | $contact,
|  |  | $redirect = `false`,
|  |  | $class = `''`,
|  |  | $textmode = `false`
| ) |  |

Referenced by contact_block().

mimetype_select | ( |  | $channel_id,
|  |  | $current = `'text/bbcode'`
| ) |  |

Referenced by editblock_content(), and editwebpage_content().

normalise_link | ( |  | $url | ) |

Referenced by best_link_url(), conversation(), delegate_content(), item_photo_menu(), link_compare(), tag_deliver(), and tgroup_check().

notags | ( |  | $string | ) |

This is our primary input filter.

The high bit hack only involved some old IE browser, forget which (IE5/Mac?) that had an XSS attack vector due to stripping the high-bit on an 8-bit character after cleansing, and angle chars with the high bit set could get through as markup.

This is now disabled because it was interfering with some legitimate unicode sequences and hopefully there aren't a lot of those browsers left.

Use this on any text input where angle chars are not valid or permitted They will be replaced with safer brackets. This may be filtered further if these are not allowed either.

Parameters

  string | $string | Input string

Returns
  string Filtered string

Referenced by admin_page_logs_post(), admin_page_site_post(), channel_content(), community_content(), connections_content(), conversation(), create_account(), directory_content(), filestorage_post(), follow_init(), get_atom_elements(), group_post(), help_content(), invite_post(), item_post(), item_store(), item_store_update(), like_content(), lostpass_post(), mail_post(), mail_store(), mood_init(), network_content(), oexchange_content(), photos_post(), poco_init(), poke_init(), profiles_post(), register_post(), sanitise_acl(), settings_post(), setup_content(), setup_post(), subthread_content(), tagger_content(), and xrd_init().

if (!function_exists('hex2bin')) paginate | ( | & | $a | ) |

Referenced by admin_page_users(), community_content(), connections_content(), match_content(), photos_content(), and viewconnections_content().

perms2str | ( |  | $p | ) |

Referenced by chat_post(), events_post(), filestorage_post(), item_post(), menu_add_item(), menu_edit_item(), photo_upload(), photos_post(), and settings_post().

photo_new_resource | ( |  | ) |

Referenced by import_channel_photo(), import_profile_photo(), and photo_upload().

preg_heart | ( |  | $x | ) |

prepare_body | ( | & | $item,
|  |  | $attach = `false`
| ) |  |

Referenced by conversation(), email_send(), and Item\get_template_data().

prepare_text | ( |  | $text,
|  |  | $content_type = `'text/bbcode'`
| ) |  |

Referenced by advanced_profile(), api_format_items(), api_format_messages(), api_status_show(), api_users_show(), atom_entry(), check_item_source(), comanche_block(), connect_content(), and prepare_body().

profiler | ( |  | $t1,
|  |  | $t2,
|  |  | $label
| ) |  |

Referenced by conversation(), and network_content().

protect_sprintf | ( |  | $s | ) |

Referenced by acl_init(), api_statuses_mentions(), attach_count_files(), attach_list_files(), channel_content(), chatroom_destroy(), connections_content(), dirsearch_content(), file_tag_file_query(), item_permissions_sql(), items_fetch(), menu_list(), network_content(), permissions_sql(), photos_list_photos(), public_permissions_sql(), search_ac_init(), search_content(), and term_query().

purify_html | ( |  | $s | ) |

Referenced by get_atom_elements(), and z_input_filter().

qp | ( |  | $s | ) |

random_string | ( |  | $size = `64`,
|  |  | $type = `RANDOM_STRING_HEX`
| ) |  |

Referenced by aes_encapsulate(), attach_mkdir(), attach_store(), bb_parse_crypt(), bbcode(), build_sync_packet(), create_account(), create_identity(), RedDirectory\createFile(), directory_run(), event_store(), fsuggest_post(), group_add(), import_directory_profile(), import_xchan(), item_message_id(), item_store(), lostpass_content(), lostpass_post(), magic_init(), mail_store(), notification(), notifier_run(), prepare_body(), profiles_init(), removeme_content(), send_message(), send_reg_approval_email(), settings_post(), setup_post(), syncdirs(), and thing_init().

reltoabs | ( |  | $text,
|  |  | $base
| ) |  |

Referenced by get_atom_elements().

replace_macros | ( |  | $s,
|  |  | $r
| ) |  |

This is our template processor

Parameters

  string | FriendicaSmarty | $s | the string requiring macro substitution, or an instance of FriendicaSmarty
  array | $r | key value pairs (search => replace)

Returns
  string substituted string

Referenced by admin_content(), admin_page_dbsync(), admin_page_hubloc(), admin_page_logs(), admin_page_plugins(), admin_page_site(), admin_page_summary(), admin_page_themes(), admin_page_users(), advanced_profile(), alt_pager(), api_apply_template(), api_content(), apps_content(), apw_form(), blocks_content(), blogtheme_form(), App\build_pagehead(), categories_widget(), channel_content(), chanview_content(), chat_content(), check_config(), check_php(), common_content(), common_friends_visitor_widget(), connect_content(), connections_content(), connedit_content(), construct_page(), contact_block(), conversation(), delegate_content(), design_tools(), dir_safe_mode(), dir_sort_links(), directory_content(), dirprofile_init(), display_content(), editblock_content(), editlayout_content(), editpost_content(), editwebpage_content(), events_content(), fbrowser_content(), field_timezone(), fileas_widget(), filer_content(), filestorage_content(), findpeople_widget(), format_categories(), format_filer(), get_birthdays(), Item\get_comment_box(), get_events(), get_feed_for(), group_content(), group_side(), help_content(), hostxrd_init(), import_content(), invite_content(), lang_selector(), layouts_content(), login(), lostpass_content(), lostpass_post(), mail_content(), manage_content(), match_content(), menu_content(), menu_render(), message_content(), micropro(), mini_group_select(), mitem_content(), mood_content(), nav(), network_content(), new_channel_content(), notification(), notifications_content(), notify_content(), oembed_format_object(), oexchange_init(), opensearch_init(), pagelist_widget(), photos_album_widget(), photos_content(), poco_init(), poke_content(), populate_acl(), posted_date_widget(), profile_sidebar(), profiles_content(), redbasic_form(), register_content(), removeme_content(), rmagic_content(), rpost_content(), search_content(), send_reg_approval_email(), send_verification_email(), setup_content(), setup_post(), siteinfo_content(), sources_content(), suggest_content(), theme_attachments(), thing_content(), user_allow(), vcard_from_xchan(), viewconnections_content(), vote_content(), webpages_content(), widget_affinity(), widget_archive(), widget_chatroom_list(), widget_filer(), widget_follow(), widget_mailmenu(), widget_notes(), widget_savedsearch(), widget_settings_menu(), widget_suggestions(), writepages_widget(), and xrd_init().

return_bytes | ( |  | $size_str | ) |

sanitise_acl | ( | & | $item | ) |

search | ( |  | $s,
|  |  | $id = `'search-box'`,
|  |  | $url = `'/search'`,
|  |  | $save = `false`
| ) |  |

Referenced by search_content().

searchbox | ( |  | $s,
|  |  | $id = `'search-box'`,
|  |  | $url = `'/search'`,
|  |  | $save = `false`
| ) |  |

Referenced by widget_savedsearch().

smile_shield | ( |  | $m | ) |

smile_unshield | ( |  | $m | ) |

smilies | ( |  | $s,
|  |  | $sample = `false`
| ) |  |

Function: smilies

Description: Replaces text emoticons with graphical images

: 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, and HTML attributes (such as urls) from being processed.

At a higher level, the bbcode [nosmile] tag can be used to prevent this function from being executed by the prepare_text() routine when preparing bbcode source for HTML display

Referenced by chatsvc_content(), mail_content(), message_content(), and smilies_content().

sslify | ( |  | $s | ) |

sslify($s) Replace media element using http url with https to a local redirector if using https locally

Parameters

  string | $s | Looks for HTML tags containing src elements that are http when we're viewing an https page Typically this throws an insecure content violation in the browser. So we redirect them to a local redirector which uses https and which redirects to the selected content

Returns
  string

Referenced by prepare_body().

stringify_array_elms | ( | & | $arr,
|  |  | $escape = `false`
| ) |  |

Referenced by expand_groups(), get_things(), identity_basic_export(), lockview_content(), notifier_run(), tagadelic(), and zot_import().

theme_attachments | ( | & | $item | ) |

Referenced by mail_content(), and prepare_body().

unamp | ( |  | $s | ) |

undo_post_tagging | ( |  | $s | ) |

Referenced by editblock_content(), editlayout_content(), editpost_content(), and editwebpage_content().

unobscure | ( | & | $item | ) |

Referenced by api_format_items(), api_format_messages(), api_status_show(), api_users_show(), and prepare_body().

unxmlify | ( |  | $s | ) |

Referenced by filer_content(), and get_atom_elements().

valid_email | ( |  | $x | ) |

Referenced by check_account_email(), invite_post(), and settings_post().

xchan_mail_query | ( | & | $item | ) |

Referenced by notifier_run().

xchan_query | ( | & | $items,
|  |  | $abook = `true`
| ) |  |

Referenced by api_format_items(), api_statuses_home_timeline(), api_statuses_public_timeline(), api_statuses_show(), channel_content(), display_content(), events_content(), home_content(), item_post(), items_fetch(), network_content(), notification(), notifier_run(), page_content(), ping_init(), search_content(), share_init(), and zot_feed().

xmlify | ( |  | $str | ) |

escape text ($str) for XML transport

Parameters

  string | $str |

Returns
  string Escaped text.

Referenced by array_xmlify(), atom_author(), atom_entry(), construct_activity_object(), construct_activity_target(), encode_rel_links(), get_atom_elements(), get_feed_for(), item_getfeedattach(), subthread_content(), tagger_content(), and xml_status().

z_input_filter | ( |  | $channel_id,
|  |  | $s,
|  |  | $type = `'text/bbcode'`
| ) |  |

Referenced by item_post(), item_store(), item_store_update(), and post_activity_item().

zidify_callback | ( |  | $match | ) |

zidify_callback() and zidify_links() work together to turn any HTML a tags with class="zrl" into zid links These will typically be generated by a bbcode '[zrl]' tag. This is done inside prepare_text() rather than bbcode() because the latter is used for general purpose conversions and the former is used only when preparing text for immediate display.

Issues: Currently the order of HTML parameters in the text is somewhat rigid and inflexible. We assume it looks like and will not work if zrl and href appear in a different order.

zidify_img_callback | ( |  | $match | ) |

zidify_links | ( |  | $s | ) |

Referenced by notification().

## Variable Documentation

const RANDOM_STRING_HEX 0x00

const RANDOM_STRING_TEXT 0x01

Referenced by aes_encapsulate(), and random_string().