util.php 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665
  1. <?php
  2. /*
  3. * StatusNet - the distributed open-source microblogging tool
  4. * Copyright (C) 2008-2011, StatusNet, Inc.
  5. *
  6. * This program is free software: you can redistribute it and/or modify
  7. * it under the terms of the GNU Affero General Public License as published by
  8. * the Free Software Foundation, either version 3 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU Affero General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Affero General Public License
  17. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  18. */
  19. /* XXX: break up into separate modules (HTTP, user, files) */
  20. /**
  21. * Show a server error.
  22. */
  23. function common_server_error($msg, $code=500)
  24. {
  25. $err = new ServerErrorAction($msg, $code);
  26. $err->showPage();
  27. }
  28. /**
  29. * Show a user error.
  30. */
  31. function common_user_error($msg, $code=400)
  32. {
  33. $err = new ClientErrorAction($msg, $code);
  34. $err->showPage();
  35. }
  36. /**
  37. * This should only be used at setup; processes switching languages
  38. * to send text to other users should use common_switch_locale().
  39. *
  40. * @param string $language Locale language code (optional; empty uses
  41. * current user's preference or site default)
  42. * @return mixed success
  43. */
  44. function common_init_locale($language=null)
  45. {
  46. if (!$language) {
  47. $language = common_language();
  48. }
  49. putenv('LANGUAGE='.$language);
  50. putenv('LANG='.$language);
  51. $ok = setlocale(LC_ALL,
  52. $language . ".utf8",
  53. $language . ".UTF8",
  54. $language . ".utf-8",
  55. $language . ".UTF-8",
  56. $language);
  57. return $ok;
  58. }
  59. /**
  60. * Initialize locale and charset settings and gettext with our message catalog,
  61. * using the current user's language preference or the site default.
  62. *
  63. * This should generally only be run at framework initialization; code switching
  64. * languages at runtime should call common_switch_language().
  65. *
  66. * @access private
  67. */
  68. function common_init_language()
  69. {
  70. mb_internal_encoding('UTF-8');
  71. // Note that this setlocale() call may "fail" but this is harmless;
  72. // gettext will still select the right language.
  73. $language = common_language();
  74. $locale_set = common_init_locale($language);
  75. if (!$locale_set) {
  76. // The requested locale doesn't exist on the system.
  77. //
  78. // gettext seems very picky... We first need to setlocale()
  79. // to a locale which _does_ exist on the system, and _then_
  80. // we can set in another locale that may not be set up
  81. // (say, ga_ES for Galego/Galician) it seems to take it.
  82. //
  83. // For some reason C and POSIX which are guaranteed to work
  84. // don't do the job. en_US.UTF-8 should be there most of the
  85. // time, but not guaranteed.
  86. $ok = common_init_locale("en_US");
  87. if (!$ok && strtolower(substr(PHP_OS, 0, 3)) != 'win') {
  88. // Try to find a complete, working locale on Unix/Linux...
  89. // @fixme shelling out feels awfully inefficient
  90. // but I don't think there's a more standard way.
  91. $all = `locale -a`;
  92. foreach (explode("\n", $all) as $locale) {
  93. if (preg_match('/\.utf[-_]?8$/i', $locale)) {
  94. $ok = setlocale(LC_ALL, $locale);
  95. if ($ok) {
  96. break;
  97. }
  98. }
  99. }
  100. }
  101. if (!$ok) {
  102. common_log(LOG_ERR, "Unable to find a UTF-8 locale on this system; UI translations may not work.");
  103. }
  104. $locale_set = common_init_locale($language);
  105. }
  106. common_init_gettext();
  107. }
  108. /**
  109. * @access private
  110. */
  111. function common_init_gettext()
  112. {
  113. setlocale(LC_CTYPE, 'C');
  114. // So we do not have to make people install the gettext locales
  115. $path = common_config('site', 'locale_path');
  116. bindtextdomain("statusnet", $path);
  117. bind_textdomain_codeset("statusnet", "UTF-8");
  118. textdomain("statusnet");
  119. }
  120. /**
  121. * Switch locale during runtime, and poke gettext until it cries uncle.
  122. * Otherwise, sometimes it doesn't actually switch away from the old language.
  123. *
  124. * @param string $language code for locale ('en', 'fr', 'pt_BR' etc)
  125. */
  126. function common_switch_locale($language=null)
  127. {
  128. common_init_locale($language);
  129. setlocale(LC_CTYPE, 'C');
  130. // So we do not have to make people install the gettext locales
  131. $path = common_config('site', 'locale_path');
  132. bindtextdomain("statusnet", $path);
  133. bind_textdomain_codeset("statusnet", "UTF-8");
  134. textdomain("statusnet");
  135. }
  136. function common_timezone()
  137. {
  138. if (common_logged_in()) {
  139. $user = common_current_user();
  140. if ($user->timezone) {
  141. return $user->timezone;
  142. }
  143. }
  144. return common_config('site', 'timezone');
  145. }
  146. function common_valid_language($lang)
  147. {
  148. if ($lang) {
  149. // Validate -- we don't want to end up with a bogus code
  150. // left over from some old junk.
  151. foreach (common_config('site', 'languages') as $code => $info) {
  152. if ($info['lang'] == $lang) {
  153. return true;
  154. }
  155. }
  156. }
  157. return false;
  158. }
  159. function common_language()
  160. {
  161. // Allow ?uselang=xx override, very useful for debugging
  162. // and helping translators check usage and context.
  163. if (isset($_GET['uselang'])) {
  164. $uselang = strval($_GET['uselang']);
  165. if (common_valid_language($uselang)) {
  166. return $uselang;
  167. }
  168. }
  169. // If there is a user logged in and they've set a language preference
  170. // then return that one...
  171. if (_have_config() && common_logged_in()) {
  172. $user = common_current_user();
  173. if (common_valid_language($user->language)) {
  174. return $user->language;
  175. }
  176. }
  177. // Otherwise, find the best match for the languages requested by the
  178. // user's browser...
  179. if (common_config('site', 'langdetect')) {
  180. $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
  181. if (!empty($httplang)) {
  182. $language = client_preferred_language($httplang);
  183. if ($language) {
  184. return $language;
  185. }
  186. }
  187. }
  188. // Finally, if none of the above worked, use the site's default...
  189. return common_config('site', 'language');
  190. }
  191. /**
  192. * Salted, hashed passwords are stored in the DB.
  193. */
  194. function common_munge_password($password, Profile $profile=null)
  195. {
  196. $hashed = null;
  197. if (Event::handle('StartHashPassword', [&$hashed, $password, $profile])) {
  198. Event::handle('EndHashPassword', [&$hashed, $password, $profile]);
  199. }
  200. if (empty($hashed)) {
  201. throw new PasswordHashException();
  202. }
  203. return $hashed;
  204. }
  205. /**
  206. * Check if a username exists and has matching password.
  207. */
  208. function common_check_user($nickname, $password)
  209. {
  210. // empty nickname always unacceptable
  211. if (empty($nickname)) {
  212. return false;
  213. }
  214. $authenticatedUser = false;
  215. if (Event::handle('StartCheckPassword', [$nickname, $password, &$authenticatedUser])) {
  216. if (common_is_email($nickname)) {
  217. $user = User::getKV('email', common_canonical_email($nickname));
  218. } else {
  219. $user = User::getKV('nickname', Nickname::normalize($nickname));
  220. }
  221. if ($user instanceof User && !empty($password)) {
  222. if (0 == strcmp(common_munge_password($password, $user->getProfile()), $user->password)) {
  223. //internal checking passed
  224. $authenticatedUser = $user;
  225. }
  226. }
  227. }
  228. Event::handle('EndCheckPassword', [$nickname, $password, $authenticatedUser]);
  229. return $authenticatedUser;
  230. }
  231. /**
  232. * Is the current user logged in?
  233. */
  234. function common_logged_in()
  235. {
  236. return (!is_null(common_current_user()));
  237. }
  238. function common_local_referer()
  239. {
  240. return isset($_SERVER['HTTP_REFERER'])
  241. && parse_url($_SERVER['HTTP_REFERER'], PHP_URL_HOST) === common_config('site', 'server');
  242. }
  243. function common_have_session()
  244. {
  245. return (0 != strcmp(session_id(), ''));
  246. }
  247. /**
  248. * Make sure session is started and handled by
  249. * the correct handler.
  250. */
  251. function common_ensure_session()
  252. {
  253. if (!common_have_session()) {
  254. if (common_config('sessions', 'handle')) {
  255. session_set_save_handler(new InternalSessionHandler(), true);
  256. }
  257. if (array_key_exists(session_name(), $_GET)) {
  258. $id = $_GET[session_name()];
  259. } elseif (array_key_exists(session_name(), $_COOKIE)) {
  260. $id = $_COOKIE[session_name()];
  261. }
  262. if (isset($id)) {
  263. session_id($id);
  264. }
  265. session_start();
  266. if (!isset($_SESSION['started'])) {
  267. $_SESSION['started'] = time();
  268. if (!empty($id)) {
  269. common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
  270. ' is set but started value is null');
  271. }
  272. }
  273. }
  274. }
  275. // Three kinds of arguments:
  276. // 1) a user object
  277. // 2) a nickname
  278. // 3) null to clear
  279. // Initialize to false; set to null if none found
  280. $_cur = false;
  281. function common_set_user($user)
  282. {
  283. global $_cur;
  284. if (is_null($user) && common_have_session()) {
  285. $_cur = null;
  286. unset($_SESSION['userid']);
  287. return true;
  288. } elseif (is_string($user)) {
  289. $nickname = $user;
  290. $user = User::getKV('nickname', $nickname);
  291. } elseif (!$user instanceof User) {
  292. return false;
  293. }
  294. if ($user) {
  295. if (Event::handle('StartSetUser', [&$user])) {
  296. if (!empty($user)) {
  297. if (!$user->hasRight(Right::WEBLOGIN)) {
  298. // TRANS: Authorisation exception thrown when a user a not allowed to login.
  299. throw new AuthorizationException(_('Not allowed to log in.'));
  300. }
  301. common_ensure_session();
  302. $_SESSION['userid'] = $user->id;
  303. $_cur = $user;
  304. Event::handle('EndSetUser', [$user]);
  305. return $_cur;
  306. }
  307. }
  308. }
  309. return false;
  310. }
  311. function common_set_cookie($key, $value, $expiration=0)
  312. {
  313. $path = common_config('site', 'path');
  314. $server = common_config('site', 'server');
  315. if ($path && ($path != '/')) {
  316. $cookiepath = '/' . $path . '/';
  317. } else {
  318. $cookiepath = '/';
  319. }
  320. return setcookie($key,
  321. $value,
  322. $expiration,
  323. $cookiepath,
  324. $server,
  325. GNUsocial::useHTTPS());
  326. }
  327. define('REMEMBERME', 'rememberme');
  328. define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
  329. function common_rememberme($user=null)
  330. {
  331. if (!$user) {
  332. $user = common_current_user();
  333. if (!$user) {
  334. return false;
  335. }
  336. }
  337. $rm = new Remember_me();
  338. $rm->code = common_random_hexstr(16);
  339. $rm->user_id = $user->id;
  340. // Wrap the insert in some good ol' fashioned transaction code
  341. $rm->query('BEGIN');
  342. $result = $rm->insert();
  343. if (!$result) {
  344. common_log_db_error($rm, 'INSERT', __FILE__);
  345. $rm->query('ROLLBACK');
  346. return false;
  347. }
  348. $rm->query('COMMIT');
  349. $cookieval = $rm->user_id . ':' . $rm->code;
  350. common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
  351. common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
  352. return true;
  353. }
  354. function common_remembered_user()
  355. {
  356. $user = null;
  357. $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
  358. if (!$packed) {
  359. return null;
  360. }
  361. list($id, $code) = explode(':', $packed);
  362. if (!$id || !$code) {
  363. common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
  364. common_forgetme();
  365. return null;
  366. }
  367. $rm = Remember_me::getKV('code', $code);
  368. if (!$rm) {
  369. common_log(LOG_WARNING, 'No such remember code: ' . $code);
  370. common_forgetme();
  371. return null;
  372. }
  373. if ($rm->user_id != $id) {
  374. common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
  375. common_forgetme();
  376. return null;
  377. }
  378. $user = User::getKV('id', $rm->user_id);
  379. if (!$user instanceof User) {
  380. common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
  381. common_forgetme();
  382. return null;
  383. }
  384. // successful!
  385. $result = $rm->delete();
  386. if (!$result) {
  387. common_log_db_error($rm, 'DELETE', __FILE__);
  388. common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
  389. common_forgetme();
  390. return null;
  391. }
  392. common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
  393. common_set_user($user);
  394. common_real_login(false);
  395. // We issue a new cookie, so they can log in
  396. // automatically again after this session
  397. common_rememberme($user);
  398. return $user;
  399. }
  400. /**
  401. * must be called with a valid user!
  402. */
  403. function common_forgetme()
  404. {
  405. common_set_cookie(REMEMBERME, '', 0);
  406. }
  407. /**
  408. * Who is the current user?
  409. */
  410. function common_current_user()
  411. {
  412. global $_cur;
  413. if (!_have_config()) {
  414. return null;
  415. }
  416. if ($_cur === false) {
  417. if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
  418. || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
  419. common_ensure_session();
  420. $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
  421. if ($id) {
  422. $user = User::getKV('id', $id);
  423. if ($user instanceof User) {
  424. $_cur = $user;
  425. return $_cur;
  426. }
  427. }
  428. }
  429. // that didn't work; try to remember; will init $_cur to null on failure
  430. $_cur = common_remembered_user();
  431. if ($_cur) {
  432. // XXX: Is this necessary?
  433. $_SESSION['userid'] = $_cur->id;
  434. }
  435. }
  436. return $_cur;
  437. }
  438. /**
  439. * Logins that are 'remembered' aren't 'real' -- they're subject to
  440. * cookie-stealing. So, we don't let them do certain things. New reg,
  441. * OpenID, and password logins _are_ real.
  442. */
  443. function common_real_login($real=true)
  444. {
  445. common_ensure_session();
  446. $_SESSION['real_login'] = $real;
  447. }
  448. function common_is_real_login()
  449. {
  450. return common_logged_in() && $_SESSION['real_login'];
  451. }
  452. /**
  453. * Get a hash portion for HTTP caching Etags and such including
  454. * info on the current user's session. If login/logout state changes,
  455. * or we've changed accounts, or we've renamed the current user,
  456. * we'll get a new hash value.
  457. *
  458. * This should not be considered secure information.
  459. *
  460. * @param User $user (optional; uses common_current_user() if left out)
  461. * @return string
  462. */
  463. function common_user_cache_hash($user=false)
  464. {
  465. if ($user === false) {
  466. $user = common_current_user();
  467. }
  468. if ($user) {
  469. return crc32($user->id . ':' . $user->nickname);
  470. } else {
  471. return '0';
  472. }
  473. }
  474. /**
  475. * get canonical version of nickname for comparison
  476. *
  477. * @param string $nickname
  478. * @return string
  479. *
  480. * @throws NicknameException on invalid input
  481. * @deprecated call Nickname::normalize() directly.
  482. */
  483. function common_canonical_nickname($nickname)
  484. {
  485. return Nickname::normalize($nickname);
  486. }
  487. /**
  488. * get canonical version of email for comparison
  489. *
  490. * @fixme actually normalize
  491. * @fixme reject invalid input
  492. *
  493. * @param string $email
  494. * @return string
  495. */
  496. function common_canonical_email($email)
  497. {
  498. // XXX: canonicalize UTF-8
  499. // XXX: lcase the domain part
  500. return $email;
  501. }
  502. function common_to_alphanumeric($str)
  503. {
  504. $filtered = preg_replace('/[^A-Za-z0-9]\s*/', '', $str);
  505. if (strlen($filtered) < 1) {
  506. throw new Exception('Filtered string was zero-length.');
  507. }
  508. return $filtered;
  509. }
  510. function common_purify($html, array $args=[])
  511. {
  512. require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
  513. $cfg = HTMLPurifier_Config::createDefault();
  514. /**
  515. * rel values that should be avoided since they can be used to infer
  516. * information about the _current_ page, not the h-entry:
  517. *
  518. * directory, home, license, payment
  519. *
  520. * Source: http://microformats.org/wiki/rel
  521. */
  522. $cfg->set('Attr.AllowedRel', ['bookmark', 'enclosure', 'nofollow', 'tag', 'noreferrer']);
  523. $cfg->set('HTML.ForbiddenAttributes', ['style']); // id, on* etc. are already filtered by default
  524. $cfg->set('URI.AllowedSchemes', array_fill_keys(common_url_schemes(), true));
  525. if (isset($args['URI.Base'])) {
  526. $cfg->set('URI.Base', $args['URI.Base']); // if null this is like unsetting it I presume
  527. $cfg->set('URI.MakeAbsolute', !is_null($args['URI.Base'])); // if we have a URI base, convert relative URLs to absolute ones.
  528. }
  529. if (common_config('cache', 'dir')) {
  530. $cfg->set('Cache.SerializerPath', common_config('cache', 'dir'));
  531. }
  532. // if you don't want to use the default cache dir for htmlpurifier, set it specifically as $config['htmlpurifier']['Cache.SerializerPath'] = '/tmp'; or something.
  533. foreach (common_config('htmlpurifier') as $key=>$val) {
  534. $cfg->set($key, $val);
  535. }
  536. // Remove more elements than what the default filter removes, default in GNU social are remotely
  537. // linked resources such as img, video, audio
  538. $forbiddenElements = [];
  539. foreach (common_config('htmlfilter') as $tag=>$filter) {
  540. if ($filter === true) {
  541. $forbiddenElements[] = $tag;
  542. }
  543. }
  544. $cfg->set('HTML.ForbiddenElements', $forbiddenElements);
  545. $html = common_remove_unicode_formatting($html);
  546. $purifier = new HTMLPurifier($cfg);
  547. $purified = $purifier->purify($html);
  548. Event::handle('EndCommonPurify', [&$purified, $html]);
  549. return $purified;
  550. }
  551. function common_remove_unicode_formatting($text)
  552. {
  553. // Strip Unicode text formatting/direction codes
  554. // this is pretty dangerous for visualisation of text and can be used for mischief
  555. return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
  556. }
  557. /**
  558. * Partial notice markup rendering step: build links to !group references.
  559. *
  560. * @param string $text partially rendered HTML
  561. * @param Profile $author the Profile that is composing the current notice
  562. * @param Notice $parent the Notice this is sent in reply to, if any
  563. * @return string partially rendered HTML
  564. */
  565. function common_render_content($text, Profile $author, Notice $parent=null)
  566. {
  567. $text = common_render_text($text);
  568. $text = common_linkify_mentions($text, $author, $parent);
  569. return $text;
  570. }
  571. /**
  572. * Finds @-mentions within the partially-rendered text section and
  573. * turns them into live links.
  574. *
  575. * Should generally not be called except from common_render_content().
  576. *
  577. * @param string $text partially-rendered HTML
  578. * @param Profile $author the Profile that is composing the current notice
  579. * @param Notice $parent the Notice this is sent in reply to, if any
  580. * @return string partially-rendered HTML
  581. */
  582. function common_linkify_mentions($text, Profile $author, Notice $parent=null)
  583. {
  584. $mentions = common_find_mentions($text, $author, $parent);
  585. // We need to go through in reverse order by position,
  586. // so our positions stay valid despite our fudging with the
  587. // string!
  588. $points = [];
  589. foreach ($mentions as $mention) {
  590. $points[$mention['position']] = $mention;
  591. }
  592. krsort($points);
  593. foreach ($points as $position => $mention) {
  594. $linkText = common_linkify_mention($mention);
  595. $text = substr_replace($text, $linkText, $position, $mention['length']);
  596. }
  597. return $text;
  598. }
  599. function common_linkify_mention(array $mention)
  600. {
  601. $output = null;
  602. if (Event::handle('StartLinkifyMention', [$mention, &$output])) {
  603. $xs = new XMLStringer(false);
  604. $attrs = ['href' => $mention['url'],
  605. 'class' => 'h-card u-url p-nickname '.$mention['type']];
  606. if (!empty($mention['title'])) {
  607. $attrs['title'] = $mention['title'];
  608. }
  609. $xs->element('a', $attrs, $mention['text']);
  610. $output = $xs->getString();
  611. Event::handle('EndLinkifyMention', [$mention, &$output]);
  612. }
  613. return $output;
  614. }
  615. function common_get_attentions($text, Profile $sender, Notice $parent=null)
  616. {
  617. $mentions = common_find_mentions($text, $sender, $parent);
  618. $atts = [];
  619. foreach ($mentions as $mention) {
  620. foreach ($mention['mentioned'] as $mentioned) {
  621. $atts[$mentioned->getUri()] = $mentioned->getObjectType();
  622. }
  623. }
  624. if ($parent instanceof Notice) {
  625. $parentAuthor = $parent->getProfile();
  626. // afaik groups can't be authors
  627. $atts[$parentAuthor->getUri()] = ActivityObject::PERSON;
  628. }
  629. return $atts;
  630. }
  631. /**
  632. * Find @-mentions in the given text, using the given notice object as context.
  633. * References will be resolved with common_relative_profile() against the user
  634. * who posted the notice.
  635. *
  636. * Note the return data format is internal, to be used for building links and
  637. * such. Should not be used directly; rather, call common_linkify_mentions().
  638. *
  639. * @param string $text
  640. * @param Profile $sender the Profile that is sending the current text
  641. * @param Notice $parent the Notice this text is in reply to, if any
  642. *
  643. * @return array
  644. *
  645. * @access private
  646. */
  647. function common_find_mentions($text, Profile $sender, Notice $parent=null)
  648. {
  649. $mentions = [];
  650. if (Event::handle('StartFindMentions', [$sender, $text, &$mentions])) {
  651. // Get the context of the original notice, if any
  652. $origMentions = [];
  653. // Does it have a parent notice for context?
  654. if ($parent instanceof Notice) {
  655. foreach ($parent->getAttentionProfiles() as $repliedTo) {
  656. if (!$repliedTo->isPerson()) {
  657. continue;
  658. }
  659. $origMentions[$repliedTo->id] = $repliedTo;
  660. }
  661. }
  662. $matches = common_find_mentions_raw($text, '@');
  663. foreach ($matches as $match) {
  664. try {
  665. $nickname = Nickname::normalize($match[0]);
  666. } catch (NicknameException $e) {
  667. // Bogus match? Drop it.
  668. continue;
  669. }
  670. // primarily mention the profiles mentioned in the parent
  671. $mention_found_in_origMentions = false;
  672. foreach ($origMentions as $origMentionsId=>$origMention) {
  673. if ($origMention->getNickname() == $nickname) {
  674. $mention_found_in_origMentions = $origMention;
  675. // don't mention same twice! the parent might have mentioned
  676. // two users with same nickname on different instances
  677. unset($origMentions[$origMentionsId]);
  678. break;
  679. }
  680. }
  681. // Try to get a profile for this nickname.
  682. // Start with parents mentions, then go to parents sender context
  683. if ($mention_found_in_origMentions) {
  684. $mentioned = $mention_found_in_origMentions;
  685. } elseif ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
  686. $mentioned = $parent->getProfile();
  687. } else {
  688. // sets to null if no match
  689. $mentioned = common_relative_profile($sender, $nickname);
  690. }
  691. if ($mentioned instanceof Profile) {
  692. try {
  693. $url = $mentioned->getUri(); // prefer the URI as URL, if it is one.
  694. if (!common_valid_http_url($url)) {
  695. $url = $mentioned->getUrl();
  696. }
  697. } catch (InvalidUrlException $e) {
  698. $url = common_local_url('userbyid', ['id' => $mentioned->getID()]);
  699. }
  700. $mention = ['mentioned' => [$mentioned],
  701. 'type' => 'mention',
  702. 'text' => $match[0],
  703. 'position' => $match[1],
  704. 'length' => mb_strlen($match[0]),
  705. 'title' => $mentioned->getFullname(),
  706. 'url' => $url];
  707. $mentions[] = $mention;
  708. }
  709. }
  710. // @#tag => mention of all subscriptions tagged 'tag'
  711. preg_match_all(
  712. '/'.Nickname::BEFORE_MENTIONS.'@#([\pL\pN_\-\.]{1,64})/',
  713. $text,
  714. $hmatches,
  715. PREG_OFFSET_CAPTURE
  716. );
  717. foreach ($hmatches[1] as $hmatch) {
  718. $tag = common_canonical_tag($hmatch[0]);
  719. $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
  720. if (!$plist instanceof Profile_list || $plist->private) {
  721. continue;
  722. }
  723. $tagged = $sender->getTaggedSubscribers($tag);
  724. $url = common_local_url('showprofiletag',
  725. ['nickname' => $sender->getNickname(),
  726. 'tag' => $tag]);
  727. $mentions[] = ['mentioned' => $tagged,
  728. 'type' => 'list',
  729. 'text' => $hmatch[0],
  730. 'position' => $hmatch[1],
  731. 'length' => mb_strlen($hmatch[0]),
  732. 'url' => $url];
  733. }
  734. $hmatches = common_find_mentions_raw($text, '!');
  735. foreach ($hmatches as $hmatch) {
  736. $nickname = Nickname::normalize($hmatch[0]);
  737. $group = User_group::getForNickname($nickname, $sender);
  738. if (!$group instanceof User_group || !$sender->isMember($group)) {
  739. continue;
  740. }
  741. $profile = $group->getProfile();
  742. $mentions[] = ['mentioned' => [$profile],
  743. 'type' => 'group',
  744. 'text' => $hmatch[0],
  745. 'position' => $hmatch[1],
  746. 'length' => mb_strlen($hmatch[0]),
  747. 'url' => $group->permalink(),
  748. 'title' => $group->getFancyName()];
  749. }
  750. Event::handle('EndFindMentions', [$sender, $text, &$mentions]);
  751. }
  752. return $mentions;
  753. }
  754. /**
  755. * Does the actual regex pulls to find @-mentions in text.
  756. * Should generally not be called directly; for use in common_find_mentions.
  757. *
  758. * @param string $text
  759. * @param string $preMention Character(s) that signals a mention ('@', '!'...)
  760. * @return array of PCRE match arrays
  761. */
  762. function common_find_mentions_raw($text, $preMention='@')
  763. {
  764. $tmatches = [];
  765. preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
  766. $text,
  767. $tmatches,
  768. PREG_OFFSET_CAPTURE);
  769. $atmatches = [];
  770. // the regexp's "(?!\@)" makes sure it doesn't matches the single "@remote" in "@remote@server.com"
  771. preg_match_all('/'.Nickname::BEFORE_MENTIONS.preg_quote($preMention, '/').'(' . Nickname::DISPLAY_FMT . ')\b(?!\@)/',
  772. $text,
  773. $atmatches,
  774. PREG_OFFSET_CAPTURE);
  775. $matches = array_merge($tmatches[1], $atmatches[1]);
  776. return $matches;
  777. }
  778. function common_render_text($text)
  779. {
  780. $text = common_remove_unicode_formatting($text);
  781. $text = nl2br(htmlspecialchars($text));
  782. $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
  783. $text = common_replace_urls_callback($text, 'common_linkify');
  784. $text = preg_replace_callback(
  785. '/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
  786. function ($m) {
  787. return "{$m[1]}#".common_tag_link($m[2]);
  788. },
  789. $text
  790. );
  791. // XXX: machine tags
  792. return $text;
  793. }
  794. define('_URL_SCHEME_COLON_DOUBLE_SLASH', 1);
  795. define('_URL_SCHEME_SINGLE_COLON', 2);
  796. define('_URL_SCHEME_NO_DOMAIN', 4);
  797. define('_URL_SCHEME_COLON_COORDINATES', 8);
  798. function common_url_schemes($filter=null)
  799. {
  800. // TODO: move these to $config
  801. $schemes = ['http' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  802. 'https' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  803. 'ftp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  804. 'ftps' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  805. 'mms' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  806. 'rtsp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  807. 'gopher' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  808. 'news' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  809. 'nntp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  810. 'telnet' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  811. 'wais' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  812. 'file' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  813. 'prospero' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  814. 'webcal' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  815. 'irc' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  816. 'ircs' => _URL_SCHEME_COLON_DOUBLE_SLASH,
  817. 'aim' => _URL_SCHEME_SINGLE_COLON,
  818. 'bitcoin' => _URL_SCHEME_SINGLE_COLON,
  819. 'fax' => _URL_SCHEME_SINGLE_COLON,
  820. 'jabber' => _URL_SCHEME_SINGLE_COLON,
  821. 'mailto' => _URL_SCHEME_SINGLE_COLON,
  822. 'tel' => _URL_SCHEME_SINGLE_COLON,
  823. 'xmpp' => _URL_SCHEME_SINGLE_COLON,
  824. 'magnet' => _URL_SCHEME_NO_DOMAIN,
  825. 'geo' => _URL_SCHEME_COLON_COORDINATES,];
  826. return array_keys(
  827. array_filter(
  828. $schemes,
  829. function ($scheme) use ($filter) {
  830. return is_null($filter) || ($scheme & $filter);
  831. })
  832. );
  833. }
  834. /**
  835. * Find links in the given text and pass them to the given callback function.
  836. *
  837. * @param string $text
  838. * @param function($text, $arg) $callback: return replacement text
  839. * @param mixed $arg: optional argument will be passed on to the callback
  840. */
  841. function common_replace_urls_callback($text, $callback, $arg = null)
  842. {
  843. $geouri_labeltext_regex = '\pN\pL\-';
  844. $geouri_mark_regex = '\-\_\.\!\~\*\\\'\(\)'; // the \\\' is really pretty
  845. $geouri_unreserved_regex = '\pN\pL' . $geouri_mark_regex;
  846. $geouri_punreserved_regex = '\[\]\:\&\+\$';
  847. $geouri_pctencoded_regex = '(?:\%[0-9a-fA-F][0-9a-fA-F])';
  848. $geouri_paramchar_regex = $geouri_unreserved_regex . $geouri_punreserved_regex; //FIXME: add $geouri_pctencoded_regex here so it works
  849. // Start off with a regex
  850. $regex = '#'.
  851. '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
  852. '('.
  853. '(?:'.
  854. '(?:'. //Known protocols
  855. '(?:'.
  856. '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_DOUBLE_SLASH)) . ')://)'.
  857. '|'.
  858. '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_SINGLE_COLON)) . '):)'.
  859. ')'.
  860. '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
  861. '(?:'.
  862. '(?:'.
  863. '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
  864. ')|(?:'.
  865. '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
  866. ')'.
  867. ')'.
  868. ')'.
  869. '|(?:'.
  870. '(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_COORDINATES)) . '):'.
  871. // There's an order that must be followed here too, if ;crs= is used, it must precede ;u=
  872. // Also 'crsp' (;crs=$crsp) must match $geouri_labeltext_regex
  873. // Also 'uval' (;u=$uval) must be a pnum: \-?[0-9]+
  874. '(?:'.
  875. '(?:[0-9]+(?:\.[0-9]+)?(?:\,[0-9]+(?:\.[0-9]+)?){1,2})'. // 1(.23)?(,4(.56)){1,2}
  876. '(?:\;(?:['.$geouri_labeltext_regex.']+)(?:\=['.$geouri_paramchar_regex.']+)*)*'.
  877. ')'.
  878. ')'.
  879. // URLs without domain name, like magnet:?xt=...
  880. '|(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_NO_DOMAIN)) . '):(?=\?))'. // zero-length lookahead requires ? after :
  881. (common_config('linkify', 'bare_ipv4') // Convert IPv4 addresses to hyperlinks
  882. ? '|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)'
  883. : '').
  884. (common_config('linkify', 'bare_ipv6') // Convert IPv6 addresses to hyperlinks
  885. ? '|(?:'. //IPv6
  886. '\[?(?:(?:(?:[0-9A-Fa-f]{1,4}:){7}(?:(?:[0-9A-Fa-f]{1,4})|:))|(?:(?:[0-9A-Fa-f]{1,4}:){6}(?::|(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})|(?::[0-9A-Fa-f]{1,4})))|(?:(?:[0-9A-Fa-f]{1,4}:){5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){4}(?::[0-9A-Fa-f]{1,4}){0,1}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){3}(?::[0-9A-Fa-f]{1,4}){0,2}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){2}(?::[0-9A-Fa-f]{1,4}){0,3}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:)(?::[0-9A-Fa-f]{1,4}){0,4}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?::(?::[0-9A-Fa-f]{1,4}){0,5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))\]?(?<!:)'.
  887. ')'
  888. : '').
  889. (common_config('linkify', 'bare_domains')
  890. ? '|(?:'. //DNS
  891. '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
  892. '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
  893. //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
  894. '(?:AC|AD|AE|AERO|AF|AG|AI|AL|AM|AN|AO|AQ|AR|ARPA|AS|ASIA|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BIZ|BJ|BM|BN|BO|BR|BS|BT|BV|BW|BY|BZ|CA|CAT|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|COM|COOP|CR|CU|CV|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EDU|EE|EG|ER|ES|ET|EU|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GOV|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|INFO|INT|IO|IQ|IR|IS|IT|JE|JM|JO|JOBS|JP|KE|KG|KH|KI|KM|KN|KP|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MG|MH|MIL|MK|ML|MM|MN|MO|MOBI|MP|MQ|MR|MS|MT|MU|MUSEUM|MV|MW|MX|MY|MZ|NA|NAME|NC|NE|NET|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|ORG|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PRO|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|ST|SU|SV|SY|SZ|TC|TD|TEL|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|TR|TRAVEL|TT|TV|TW|TZ|UA|UG|UK|US|UY|UZ|VA|VC|VE|VG|VI|VN|VU|WF|WS|XN--0ZWM56D|测试|XN--11B5BS3A9AJ6G|परीक्षा|XN--80AKHBYKNJ4F|испытание|XN--9T4B11YI5A|테스트|XN--DEBA0AD|טעסט|XN--G6W251D|測試|XN--HGBK6AJ7F53BBA|آزمایشی|XN--HLCJ6AYA9ESC7A|பரிட்சை|XN--JXALPDLP|δοκιμή|XN--KGBECHTV|إختبار|XN--ZCKZAH|テスト|YE|YT|YU|ZA|ZM|ZONE|ZW|local|loc|onion)'.
  895. ')(?![\pN\pL\-\_])'
  896. : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
  897. ')'.
  898. '(?:'.
  899. '(?:\:\d+)?'. //:port
  900. '(?:/[' . URL_REGEX_VALID_PATH_CHARS . ']*)?'. // path
  901. '(?:\?[' . URL_REGEX_VALID_QSTRING_CHARS . ']*)?'. // ?query string
  902. '(?:\#[' . URL_REGEX_VALID_FRAGMENT_CHARS . ']*)?'. // #fragment
  903. ')(?<!['. URL_REGEX_EXCLUDED_END_CHARS .'])'.
  904. ')'.
  905. '#ixu';
  906. //preg_match_all($regex,$text,$matches);
  907. //print_r($matches);
  908. return preg_replace_callback($regex, curry('callback_helper', $callback, $arg), $text);
  909. }
  910. /**
  911. * Intermediate callback for common_replace_links(), helps resolve some
  912. * ambiguous link forms before passing on to the final callback.
  913. *
  914. * @param array $matches
  915. * @param callable $callback
  916. * @param mixed $arg optional argument to pass on as second param to callback
  917. * @return string
  918. *
  919. * @access private
  920. */
  921. function callback_helper($matches, $callback, $arg=null)
  922. {
  923. $url=$matches[1];
  924. $left = strpos($matches[0], $url);
  925. $right = $left+strlen($url);
  926. $groupSymbolSets=[
  927. [
  928. 'left'=>'(',
  929. 'right'=>')'
  930. ],
  931. [
  932. 'left'=>'[',
  933. 'right'=>']'
  934. ],
  935. [
  936. 'left'=>'{',
  937. 'right'=>'}'
  938. ],
  939. [
  940. 'left'=>'<',
  941. 'right'=>'>'
  942. ]
  943. ];
  944. $cannotEndWith=['.','?',',','#'];
  945. $original_url=$url;
  946. do {
  947. $original_url=$url;
  948. foreach ($groupSymbolSets as $groupSymbolSet) {
  949. if (substr($url, -1)==$groupSymbolSet['right']) {
  950. $group_left_count = substr_count($url, $groupSymbolSet['left']);
  951. $group_right_count = substr_count($url, $groupSymbolSet['right']);
  952. if ($group_left_count<$group_right_count) {
  953. $right-=1;
  954. $url=substr($url, 0, -1);
  955. }
  956. }
  957. }
  958. if (in_array(substr($url, -1), $cannotEndWith)) {
  959. $right-=1;
  960. $url=substr($url, 0, -1);
  961. }
  962. } while ($original_url!=$url);
  963. $result = call_user_func_array($callback, [$url, $arg]);
  964. return substr($matches[0], 0, $left) . $result . substr($matches[0], $right);
  965. }
  966. require_once INSTALLDIR . "/lib/curry.php";
  967. function common_linkify($url)
  968. {
  969. // It comes in special'd, so we unspecial it before passing to the stringifying
  970. // functions
  971. $url = htmlspecialchars_decode($url);
  972. if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
  973. //url is an email address without the mailto: protocol
  974. $canon = "mailto:$url";
  975. $longurl = "mailto:$url";
  976. } else {
  977. $canon = File_redirection::_canonUrl($url);
  978. $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
  979. if (isset($longurl_data->redir_url)) {
  980. $longurl = $longurl_data->redir_url;
  981. } else {
  982. // e.g. local files
  983. $longurl = $longurl_data->url;
  984. }
  985. }
  986. $attrs = ['href' => $longurl, 'title' => $longurl];
  987. $is_attachment = false;
  988. $attachment_id = null;
  989. $has_thumb = false;
  990. // Check to see whether this is a known "attachment" URL.
  991. try {
  992. $f = File::getByUrl($longurl);
  993. } catch (NoResultException $e) {
  994. if (common_config('attachments', 'process_links')) {
  995. // XXX: this writes to the database. :<
  996. try {
  997. $f = File::processNew($longurl);
  998. } catch (ServerException $e) {
  999. $f = null;
  1000. }
  1001. }
  1002. }
  1003. if ($f instanceof File) {
  1004. try {
  1005. $enclosure = $f->getEnclosure();
  1006. $is_attachment = true;
  1007. $attachment_id = $f->id;
  1008. $thumb = File_thumbnail::getKV('file_id', $f->id);
  1009. $has_thumb = ($thumb instanceof File_thumbnail);
  1010. } catch (ServerException $e) {
  1011. // There was not enough metadata available
  1012. }
  1013. }
  1014. // Whether to nofollow
  1015. $nf = common_config('nofollow', 'external');
  1016. if ($nf == 'never') {
  1017. $attrs['rel'] = 'external';
  1018. } else {
  1019. $attrs['rel'] = 'nofollow external';
  1020. }
  1021. // Add clippy
  1022. if ($is_attachment) {
  1023. $attrs['class'] = 'attachment';
  1024. if ($has_thumb) {
  1025. $attrs['class'] = 'attachment thumbnail';
  1026. }
  1027. $attrs['id'] = "attachment-{$attachment_id}";
  1028. $attrs['rel'] .= ' noreferrer';
  1029. }
  1030. return XMLStringer::estring('a', $attrs, $url);
  1031. }
  1032. /**
  1033. * Find and shorten links in a given chunk of text if it's longer than the
  1034. * configured notice content limit (or unconditionally).
  1035. *
  1036. * Side effects: may save file and file_redirection records for referenced URLs.
  1037. *
  1038. * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
  1039. * user's options are used; otherwise the current web session user's setitngs
  1040. * will be used or ur1.ca if there is no active web login.
  1041. *
  1042. * @param string $text
  1043. * @param boolean $always (optional)
  1044. * @param User $user (optional)
  1045. *
  1046. * @return string
  1047. */
  1048. function common_shorten_links($text, $always = false, User $user=null)
  1049. {
  1050. if ($user === null) {
  1051. $user = common_current_user();
  1052. }
  1053. $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
  1054. if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
  1055. return common_replace_urls_callback($text, ['File_redirection', 'forceShort'], $user);
  1056. } else {
  1057. return common_replace_urls_callback($text, ['File_redirection', 'makeShort'], $user);
  1058. }
  1059. }
  1060. /**
  1061. * Very basic stripping of invalid UTF-8 input text.
  1062. *
  1063. * @param string $str
  1064. * @return mixed string or null if invalid input
  1065. *
  1066. * @todo ideally we should drop bad chars, and maybe do some of the checks
  1067. * from common_xml_safe_str. But we can't strip newlines, etc.
  1068. * @todo Unicode normalization might also be useful, but not needed now.
  1069. */
  1070. function common_validate_utf8($str)
  1071. {
  1072. // preg_replace will return NULL on invalid UTF-8 input.
  1073. //
  1074. // Note: empty regex //u also caused NULL return on some
  1075. // production machines, but none of our test machines.
  1076. //
  1077. // This should be replaced with a more reliable check.
  1078. return preg_replace('/\x00/u', '', $str);
  1079. }
  1080. /**
  1081. * Make sure an arbitrary string is safe for output in XML as a single line.
  1082. *
  1083. * @param string $str
  1084. * @return string
  1085. */
  1086. function common_xml_safe_str($str)
  1087. {
  1088. // Replace common eol and extra whitespace input chars
  1089. $unWelcome = ["\t", // tab
  1090. "\n", // newline
  1091. "\r", // cr
  1092. "\0", // null byte eos
  1093. "\x0B"]; // vertical tab
  1094. $replacement = [' ', // single space
  1095. ' ',
  1096. '', // nothing
  1097. '',
  1098. ' '];
  1099. $str = str_replace($unWelcome, $replacement, $str);
  1100. // Neutralize any additional control codes and UTF-16 surrogates
  1101. // (Twitter uses '*')
  1102. return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
  1103. }
  1104. function common_slugify($str)
  1105. {
  1106. // php5-intl is highly recommended...
  1107. if (!function_exists('transliterator_transliterate')) {
  1108. $str = preg_replace('/[^\pL\pN]/u', '', $str);
  1109. $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
  1110. $str = substr($str, 0, 64);
  1111. return $str;
  1112. }
  1113. $str = transliterator_transliterate('Any-Latin;' . // any charset to latin compatible
  1114. 'NFD;' . // decompose
  1115. '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
  1116. 'NFC;' . // composite again
  1117. '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
  1118. 'Lower();' . // turn into lowercase
  1119. 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
  1120. $str);
  1121. return preg_replace('/[^\pL\pN]/', '', $str);
  1122. }
  1123. function common_tag_link($tag)
  1124. {
  1125. $canonical = common_canonical_tag($tag);
  1126. if (common_config('singleuser', 'enabled')) {
  1127. // regular TagAction isn't set up in 1user mode
  1128. $nickname = User::singleUserNickname();
  1129. $url = common_local_url('showstream', ['nickname' => $nickname, 'tag' => $canonical]);
  1130. } else {
  1131. $url = common_local_url('tag', ['tag' => $canonical]);
  1132. }
  1133. $xs = new XMLStringer();
  1134. $xs->elementStart('span', 'tag');
  1135. $xs->element('a', ['href' => $url, 'rel' => 'tag'], $tag);
  1136. $xs->elementEnd('span');
  1137. return $xs->getString();
  1138. }
  1139. function common_canonical_tag($tag)
  1140. {
  1141. $tag = common_slugify($tag);
  1142. $tag = substr($tag, 0, 64);
  1143. return $tag;
  1144. }
  1145. function common_valid_profile_tag($str)
  1146. {
  1147. return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
  1148. }
  1149. /**
  1150. * Resolve an ambiguous profile nickname reference, checking in following order:
  1151. * - profiles that $sender subscribes to
  1152. * - profiles that subscribe to $sender
  1153. * - local user profiles
  1154. *
  1155. * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
  1156. * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
  1157. * ESCAPE SQL.
  1158. *
  1159. * @fixme validate input
  1160. * @fixme escape SQL
  1161. * @fixme fix or remove mystery third parameter
  1162. * @fixme is $sender a User or Profile?
  1163. *
  1164. * @param <type> $sender the user or profile in whose context we're looking
  1165. * @param string $nickname validated nickname of
  1166. * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
  1167. *
  1168. * @return Profile or null
  1169. */
  1170. function common_relative_profile($sender, $nickname, $dt=null)
  1171. {
  1172. // Will throw exception on invalid input.
  1173. $nickname = Nickname::normalize($nickname);
  1174. // Try to find profiles this profile is subscribed to that have this nickname
  1175. $recipient = new Profile();
  1176. // XXX: use a join instead of a subquery
  1177. $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
  1178. $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
  1179. if ($recipient->find(true)) {
  1180. // XXX: should probably differentiate between profiles with
  1181. // the same name by date of most recent update
  1182. return $recipient;
  1183. }
  1184. // Try to find profiles that listen to this profile and that have this nickname
  1185. $recipient = new Profile();
  1186. // XXX: use a join instead of a subquery
  1187. $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
  1188. $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
  1189. if ($recipient->find(true)) {
  1190. // XXX: should probably differentiate between profiles with
  1191. // the same name by date of most recent update
  1192. return $recipient;
  1193. }
  1194. // If this is a local user, try to find a local user with that nickname.
  1195. $sender = User::getKV('id', $sender->id);
  1196. if ($sender instanceof User) {
  1197. $recipient_user = User::getKV('nickname', $nickname);
  1198. if ($recipient_user instanceof User) {
  1199. return $recipient_user->getProfile();
  1200. }
  1201. }
  1202. // Otherwise, no links. @messages from local users to remote users,
  1203. // or from remote users to other remote users, are just
  1204. // outside our ability to make intelligent guesses about
  1205. return null;
  1206. }
  1207. function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
  1208. {
  1209. if (Event::handle('StartLocalURL', [&$action, &$params, &$fragment, &$addSession, &$url])) {
  1210. $r = Router::get();
  1211. $path = $r->build($action, $args, $params, $fragment);
  1212. $ssl = GNUsocial::useHTTPS();
  1213. if (common_config('site', 'fancy')) {
  1214. $url = common_path($path, $ssl, $addSession);
  1215. } else {
  1216. if (mb_strpos($path, '/index.php') === 0) {
  1217. $url = common_path($path, $ssl, $addSession);
  1218. } else {
  1219. $url = common_path('index.php/'.$path, $ssl, $addSession);
  1220. }
  1221. }
  1222. Event::handle('EndLocalURL', [&$action, &$params, &$fragment, &$addSession, &$url]);
  1223. }
  1224. return $url;
  1225. }
  1226. function common_path($relative, $ssl=false, $addSession=true)
  1227. {
  1228. $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
  1229. if ($ssl && GNUsocial::useHTTPS()) {
  1230. $proto = 'https';
  1231. if (is_string(common_config('site', 'sslserver')) &&
  1232. mb_strlen(common_config('site', 'sslserver')) > 0) {
  1233. $serverpart = common_config('site', 'sslserver');
  1234. } elseif (common_config('site', 'server')) {
  1235. $serverpart = common_config('site', 'server');
  1236. } else {
  1237. common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
  1238. }
  1239. } else {
  1240. $proto = 'http';
  1241. if (common_config('site', 'server')) {
  1242. $serverpart = common_config('site', 'server');
  1243. } else {
  1244. common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
  1245. }
  1246. }
  1247. if ($addSession) {
  1248. $relative = common_inject_session($relative, $serverpart);
  1249. }
  1250. return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
  1251. }
  1252. // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
  1253. function common_fake_local_fancy_url($url)
  1254. {
  1255. /**
  1256. * This is a hacky fix to make URIs generated with "index.php/" match against
  1257. * locally stored URIs without that. So for example if the remote site is looking
  1258. * up the webfinger for some user and for some reason knows about https://some.example/user/1
  1259. * but we locally store and report only https://some.example/index.php/user/1 then they would
  1260. * dismiss the profile for not having an identified alias.
  1261. *
  1262. * There are various live instances where these issues occur, for various reasons.
  1263. * Most of them being users fiddling with configuration while already having
  1264. * started federating (distributing the URI to other servers) or maybe manually
  1265. * editing the local database.
  1266. */
  1267. if (!preg_match(
  1268. // [1] protocol part, we can only rewrite http/https anyway.
  1269. '/^(https?:\/\/)' .
  1270. // [2] site name.
  1271. // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
  1272. '('.preg_quote(common_config('site', 'server'), '/').')' .
  1273. // [3] site path, or if that is empty just '/' (to retain the /)
  1274. '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
  1275. // [4] + [5] extract index.php (+ possible leading double /) and the rest of the URL separately.
  1276. '(\/?index\.php\/)(.*)$/',
  1277. $url,
  1278. $matches
  1279. )) {
  1280. // if preg_match failed to match
  1281. throw new Exception('No known change could be made to the URL.');
  1282. }
  1283. // now reconstruct the URL with everything except the "index.php/" part
  1284. $fancy_url = '';
  1285. foreach ([1,2,3,5] as $idx) {
  1286. $fancy_url .= $matches[$idx];
  1287. }
  1288. return $fancy_url;
  1289. }
  1290. // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
  1291. function common_fake_local_nonfancy_url($url)
  1292. {
  1293. /**
  1294. * This is a hacky fix to make URIs NOT generated with "index.php/" match against
  1295. * locally stored URIs WITH that. The reverse from the above.
  1296. *
  1297. * It will also "repair" index.php URLs with multiple / prepended. Like https://some.example///index.php/user/1
  1298. */
  1299. if (!preg_match(
  1300. // [1] protocol part, we can only rewrite http/https anyway.
  1301. '/^(https?:\/\/)' .
  1302. // [2] site name.
  1303. // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
  1304. '('.preg_quote(common_config('site', 'server'), '/').')' .
  1305. // [3] site path, or if that is empty just '/' (to retain the /)
  1306. '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
  1307. // [4] should be empty (might contain one or more / and then maybe also index.php). Will be overwritten.
  1308. // [5] will have the extracted actual URL part (besides site path)
  1309. '((?!index.php\/)\/*(?:index.php\/)?)(.*)$/',
  1310. $url,
  1311. $matches
  1312. )) {
  1313. // if preg_match failed to match
  1314. throw new Exception('No known change could be made to the URL.');
  1315. }
  1316. $matches[4] = 'index.php/'; // inject the index.php/ rewritethingy
  1317. // remove the first element, which is the full matching string
  1318. array_shift($matches);
  1319. return implode($matches);
  1320. }
  1321. function common_inject_session($url, $serverpart = null)
  1322. {
  1323. if (!common_have_session()) {
  1324. return $url;
  1325. }
  1326. if (empty($serverpart)) {
  1327. $serverpart = parse_url($url, PHP_URL_HOST);
  1328. }
  1329. $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
  1330. // Are we pointing to another server (like an SSL server?)
  1331. if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
  1332. // Pass the session ID as a GET parameter
  1333. $sesspart = session_name() . '=' . session_id();
  1334. $i = strpos($url, '?');
  1335. if ($i === false) { // no GET params, just append
  1336. $url .= '?' . $sesspart;
  1337. } else {
  1338. $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
  1339. }
  1340. }
  1341. return $url;
  1342. }
  1343. function common_date_string($dt)
  1344. {
  1345. // XXX: do some sexy date formatting
  1346. // return date(DATE_RFC822, $dt);
  1347. $t = strtotime($dt);
  1348. $now = time();
  1349. $diff = $now - $t;
  1350. if ($now < $t) { // that shouldn't happen!
  1351. return common_exact_date($dt);
  1352. } elseif ($diff < 60) {
  1353. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1354. return _('a few seconds ago');
  1355. } elseif ($diff < 92) {
  1356. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1357. return _('about a minute ago');
  1358. } elseif ($diff < 3300) {
  1359. $minutes = round($diff/60);
  1360. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1361. return sprintf(_m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
  1362. } elseif ($diff < 5400) {
  1363. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1364. return _('about an hour ago');
  1365. } elseif ($diff < 22 * 3600) {
  1366. $hours = round($diff/3600);
  1367. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1368. return sprintf(_m('about one hour ago', 'about %d hours ago', $hours), $hours);
  1369. } elseif ($diff < 37 * 3600) {
  1370. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1371. return _('about a day ago');
  1372. } elseif ($diff < 24 * 24 * 3600) {
  1373. $days = round($diff/(24*3600));
  1374. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1375. return sprintf(_m('about one day ago', 'about %d days ago', $days), $days);
  1376. } elseif ($diff < 46 * 24 * 3600) {
  1377. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1378. return _('about a month ago');
  1379. } elseif ($diff < 330 * 24 * 3600) {
  1380. $months = round($diff/(30*24*3600));
  1381. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1382. return sprintf(_m('about one month ago', 'about %d months ago', $months), $months);
  1383. } elseif ($diff < 480 * 24 * 3600) {
  1384. // TRANS: Used in notices to indicate when the notice was made compared to now.
  1385. return _('about a year ago');
  1386. } else {
  1387. return common_exact_date($dt);
  1388. }
  1389. }
  1390. function common_exact_date($dt)
  1391. {
  1392. static $_utc;
  1393. static $_siteTz;
  1394. if (!$_utc) {
  1395. $_utc = new DateTimeZone('UTC');
  1396. $_siteTz = new DateTimeZone(common_timezone());
  1397. }
  1398. $dateStr = date('d F Y H:i:s', strtotime($dt));
  1399. $d = new DateTime($dateStr, $_utc);
  1400. $d->setTimezone($_siteTz);
  1401. // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
  1402. return $d->format(_('l, d-M-Y H:i:s T'));
  1403. }
  1404. function common_date_w3dtf($dt)
  1405. {
  1406. $dateStr = date('d F Y H:i:s', strtotime($dt));
  1407. $d = new DateTime($dateStr, new DateTimeZone('UTC'));
  1408. $d->setTimezone(new DateTimeZone(common_timezone()));
  1409. return $d->format(DATE_W3C);
  1410. }
  1411. function common_date_rfc2822($dt)
  1412. {
  1413. $dateStr = date('d F Y H:i:s', strtotime($dt));
  1414. $d = new DateTime($dateStr, new DateTimeZone('UTC'));
  1415. $d->setTimezone(new DateTimeZone(common_timezone()));
  1416. return $d->format('r');
  1417. }
  1418. function common_date_iso8601($dt)
  1419. {
  1420. $dateStr = date('d F Y H:i:s', strtotime($dt));
  1421. $d = new DateTime($dateStr, new DateTimeZone('UTC'));
  1422. $d->setTimezone(new DateTimeZone(common_timezone()));
  1423. return $d->format('c');
  1424. }
  1425. function common_sql_now()
  1426. {
  1427. return common_sql_date(time());
  1428. }
  1429. function common_sql_date($datetime)
  1430. {
  1431. return strftime('%Y-%m-%d %H:%M:%S', $datetime);
  1432. }
  1433. /**
  1434. * Return an SQL fragment to calculate an age-based weight from a given
  1435. * timestamp or datetime column.
  1436. *
  1437. * @param string $column name of field we're comparing against current time
  1438. * @param integer $dropoff divisor for age in seconds before exponentiation
  1439. * @return string SQL fragment
  1440. */
  1441. function common_sql_weight($column, $dropoff)
  1442. {
  1443. if (common_config('db', 'type') == 'pgsql') {
  1444. // PostgreSQL doesn't support timestampdiff function.
  1445. // @fixme will this use the right time zone?
  1446. // @fixme does this handle cross-year subtraction correctly?
  1447. return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
  1448. } else {
  1449. return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
  1450. }
  1451. }
  1452. function common_redirect($url, $code=307)
  1453. {
  1454. static $status = [301 => "Moved Permanently",
  1455. 302 => "Found",
  1456. 303 => "See Other",
  1457. 307 => "Temporary Redirect"];
  1458. header('HTTP/1.1 '.$code.' '.$status[$code]);
  1459. header("Location: $url");
  1460. header("Connection: close");
  1461. $xo = new XMLOutputter();
  1462. $xo->startXML(
  1463. 'a',
  1464. '-//W3C//DTD XHTML 1.0 Strict//EN',
  1465. 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
  1466. );
  1467. $xo->element('a', ['href' => $url], $url);
  1468. $xo->endXML();
  1469. exit;
  1470. }
  1471. // Stick the notice on the queue
  1472. function common_enqueue_notice($notice)
  1473. {
  1474. static $localTransports = ['ping'];
  1475. $transports = [];
  1476. if (common_config('sms', 'enabled')) {
  1477. $transports[] = 'sms';
  1478. }
  1479. if (Event::hasHandler('HandleQueuedNotice')) {
  1480. $transports[] = 'plugin';
  1481. }
  1482. // We can skip these for gatewayed notices.
  1483. if ($notice->isLocal()) {
  1484. $transports = array_merge($transports, $localTransports);
  1485. }
  1486. if (Event::handle('StartEnqueueNotice', [$notice, &$transports])) {
  1487. $qm = QueueManager::get();
  1488. foreach ($transports as $transport) {
  1489. $qm->enqueue($notice, $transport);
  1490. }
  1491. Event::handle('EndEnqueueNotice', [$notice, $transports]);
  1492. }
  1493. return true;
  1494. }
  1495. function common_profile_url($nickname)
  1496. {
  1497. return common_local_url('showstream',
  1498. ['nickname' => $nickname],
  1499. null,
  1500. null,
  1501. false);
  1502. }
  1503. /**
  1504. * Should make up a reasonable root URL
  1505. *
  1506. * @param bool $tls true or false to force TLS scheme, null to use server configuration
  1507. */
  1508. function common_root_url($tls=null)
  1509. {
  1510. if (is_null($tls)) {
  1511. $tls = GNUsocial::useHTTPS();
  1512. }
  1513. $url = common_path('', $tls, false);
  1514. $i = strpos($url, '?');
  1515. if ($i !== false) {
  1516. $url = substr($url, 0, $i);
  1517. }
  1518. return $url;
  1519. }
  1520. /**
  1521. * returns $bytes bytes of raw random data
  1522. */
  1523. function common_random_rawstr($bytes)
  1524. {
  1525. $rawstr = @file_exists('/dev/urandom')
  1526. ? common_urandom($bytes)
  1527. : common_mtrand($bytes);
  1528. return $rawstr;
  1529. }
  1530. /**
  1531. * returns $bytes bytes of random data as a hexadecimal string
  1532. */
  1533. function common_random_hexstr($bytes)
  1534. {
  1535. return bin2hex(random_bytes($bytes));
  1536. }
  1537. function common_urandom($bytes)
  1538. {
  1539. $h = fopen('/dev/urandom', 'rb');
  1540. // should not block
  1541. $src = fread($h, $bytes);
  1542. fclose($h);
  1543. return $src;
  1544. }
  1545. function common_mtrand($bytes)
  1546. {
  1547. $str = '';
  1548. for ($i = 0; $i < $bytes; $i++) {
  1549. $str .= chr(mt_rand(0, 255));
  1550. }
  1551. return $str;
  1552. }
  1553. /**
  1554. * Record the given URL as the return destination for a future
  1555. * form submission, to be read by common_get_returnto().
  1556. *
  1557. * @param string $url
  1558. *
  1559. * @fixme as a session-global setting, this can allow multiple forms
  1560. * to conflict and overwrite each others' returnto destinations if
  1561. * the user has multiple tabs or windows open.
  1562. *
  1563. * Should refactor to index with a token or otherwise only pass the
  1564. * data along its intended path.
  1565. */
  1566. function common_set_returnto($url)
  1567. {
  1568. common_ensure_session();
  1569. $_SESSION['returnto'] = $url;
  1570. }
  1571. /**
  1572. * Fetch a return-destination URL previously recorded by
  1573. * common_set_returnto().
  1574. *
  1575. * @return mixed URL string or null
  1576. *
  1577. * @fixme as a session-global setting, this can allow multiple forms
  1578. * to conflict and overwrite each others' returnto destinations if
  1579. * the user has multiple tabs or windows open.
  1580. *
  1581. * Should refactor to index with a token or otherwise only pass the
  1582. * data along its intended path.
  1583. */
  1584. function common_get_returnto()
  1585. {
  1586. common_ensure_session();
  1587. return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
  1588. }
  1589. function common_timestamp()
  1590. {
  1591. return date('YmdHis');
  1592. }
  1593. function common_ensure_syslog()
  1594. {
  1595. static $initialized = false;
  1596. if (!$initialized) {
  1597. openlog(
  1598. common_config('syslog', 'appname'),
  1599. 0,
  1600. common_config('syslog', 'facility')
  1601. );
  1602. $initialized = true;
  1603. }
  1604. }
  1605. function common_log_line($priority, $msg)
  1606. {
  1607. static $syslog_priorities = ['LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
  1608. 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG'];
  1609. return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
  1610. }
  1611. function common_request_id()
  1612. {
  1613. $pid = getmypid();
  1614. $server = common_config('site', 'server');
  1615. if (php_sapi_name() == 'cli') {
  1616. $script = basename($_SERVER['PHP_SELF']);
  1617. return "$server:$script:$pid";
  1618. } else {
  1619. static $req_id = null;
  1620. if (!isset($req_id)) {
  1621. $req_id = substr(md5(mt_rand()), 0, 8);
  1622. }
  1623. if (isset($_SERVER['REQUEST_URI'])) {
  1624. $url = $_SERVER['REQUEST_URI'];
  1625. }
  1626. $method = $_SERVER['REQUEST_METHOD'];
  1627. return "$server:$pid.$req_id $method $url";
  1628. }
  1629. }
  1630. function common_log($priority, $msg, $filename=null)
  1631. {
  1632. // Don't write LOG_DEBUG if that's not wanted
  1633. if ($priority === LOG_DEBUG && !common_config('site', 'logdebug')) {
  1634. return;
  1635. }
  1636. if (Event::handle('StartLog', [&$priority, &$msg, &$filename])) {
  1637. $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
  1638. $msg = '[' . common_request_id() . '] ' . $msg;
  1639. $logfile = common_config('site', 'logfile');
  1640. if ($logfile) {
  1641. $log = fopen($logfile, "a");
  1642. if ($log) {
  1643. $output = common_log_line($priority, $msg);
  1644. fwrite($log, $output);
  1645. fclose($log);
  1646. }
  1647. } else {
  1648. common_ensure_syslog();
  1649. syslog($priority, $msg);
  1650. }
  1651. Event::handle('EndLog', [$priority, $msg, $filename]);
  1652. }
  1653. }
  1654. function common_debug($msg, $filename=null)
  1655. {
  1656. if ($filename) {
  1657. common_log(LOG_DEBUG, basename($filename).' - '.$msg);
  1658. } else {
  1659. common_log(LOG_DEBUG, $msg);
  1660. }
  1661. }
  1662. function common_log_db_error(&$object, $verb, $filename=null)
  1663. {
  1664. global $_PEAR;
  1665. $objstr = common_log_objstring($object);
  1666. $last_error = &$_PEAR->getStaticProperty('DB_DataObject', 'lastError');
  1667. if (is_object($last_error)) {
  1668. $msg = $last_error->message;
  1669. } else {
  1670. $msg = 'Unknown error (' . var_export($last_error, true) . ')';
  1671. }
  1672. common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
  1673. }
  1674. function common_log_objstring(&$object)
  1675. {
  1676. if (is_null($object)) {
  1677. return "null";
  1678. }
  1679. if (!($object instanceof DB_DataObject)) {
  1680. return "(unknown)";
  1681. }
  1682. $arr = $object->toArray();
  1683. $fields = [];
  1684. foreach ($arr as $k => $v) {
  1685. if (is_object($v)) {
  1686. $fields[] = "$k='".get_class($v)."'";
  1687. } else {
  1688. $fields[] = "$k='$v'";
  1689. }
  1690. }
  1691. $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
  1692. return $objstring;
  1693. }
  1694. function common_valid_http_url($url, $secure=false)
  1695. {
  1696. if (empty($url)) {
  1697. return false;
  1698. }
  1699. // If $secure is true, only allow https URLs to pass
  1700. // (if false, we use '?' in 'https?' to say the 's' is optional)
  1701. $regex = $secure ? '/^https$/' : '/^https?$/';
  1702. return filter_var($url, FILTER_VALIDATE_URL)
  1703. && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
  1704. }
  1705. function common_valid_tag($tag)
  1706. {
  1707. if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
  1708. return (Validate::email($matches[1]) ||
  1709. preg_match('/^([\w-\.]+)$/', $matches[1]));
  1710. }
  1711. return false;
  1712. }
  1713. /**
  1714. * Determine if given domain or address literal is valid
  1715. * eg for use in JIDs and URLs. Does not check if the domain
  1716. * exists!
  1717. *
  1718. * @param string $domain
  1719. * @return boolean valid or not
  1720. */
  1721. function common_valid_domain($domain)
  1722. {
  1723. $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
  1724. $ipv4 = "(?:$octet(?:\.$octet){3})";
  1725. if (preg_match("/^$ipv4$/u", $domain)) {
  1726. return true;
  1727. }
  1728. $group = "(?:[0-9a-f]{1,4})";
  1729. $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
  1730. if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
  1731. $before = explode(":", $matches[1]);
  1732. $zeroes = $matches[2];
  1733. $after = explode(":", $matches[3]);
  1734. if ($zeroes) {
  1735. $min = 0;
  1736. $max = 7;
  1737. } else {
  1738. $min = 1;
  1739. $max = 8;
  1740. }
  1741. $explicit = count($before) + count($after);
  1742. if ($explicit < $min || $explicit > $max) {
  1743. return false;
  1744. }
  1745. return true;
  1746. }
  1747. try {
  1748. require_once "Net/IDNA.php";
  1749. $idn = Net_IDNA::getInstance();
  1750. $domain = $idn->encode($domain);
  1751. } catch (Exception $e) {
  1752. return false;
  1753. }
  1754. $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
  1755. $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
  1756. return preg_match("/^$fqdn$/ui", $domain);
  1757. }
  1758. /* Following functions are copied from MediaWiki GlobalFunctions.php
  1759. * and written by Evan Prodromou. */
  1760. function common_accept_to_prefs($accept, $def = '*/*')
  1761. {
  1762. // No arg means accept anything (per HTTP spec)
  1763. if (!$accept) {
  1764. return [$def => 1];
  1765. }
  1766. $prefs = [];
  1767. $parts = explode(',', $accept);
  1768. foreach ($parts as $part) {
  1769. // FIXME: doesn't deal with params like 'text/html; level=1'
  1770. @list($value, $qpart) = explode(';', trim($part));
  1771. $match = [];
  1772. if (!isset($qpart)) {
  1773. $prefs[$value] = 1;
  1774. } elseif (preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
  1775. $prefs[$value] = $match[1];
  1776. }
  1777. }
  1778. return $prefs;
  1779. }
  1780. // Match by our supported file extensions
  1781. function common_supported_filename_to_mime($filename)
  1782. {
  1783. // Accept a filename and take out the extension
  1784. if (strpos($filename, '.') === false) {
  1785. throw new ServerException(sprintf('No extension on filename: %1$s', _ve($filename)));
  1786. }
  1787. $fileext = substr(strrchr($filename, '.'), 1);
  1788. return common_supported_ext_to_mime($fileext);
  1789. }
  1790. function common_supported_ext_to_mime($fileext)
  1791. {
  1792. $supported = common_config('attachments', 'supported');
  1793. if ($supported === true) {
  1794. // FIXME: Should we just accept the extension straight off when supported === true?
  1795. throw new UnknownExtensionMimeException($fileext);
  1796. }
  1797. foreach ($supported as $type => $ext) {
  1798. if ($ext === $fileext) {
  1799. return $type;
  1800. }
  1801. }
  1802. throw new ServerException('Unsupported file extension');
  1803. }
  1804. // Match by our supported mime types
  1805. function common_supported_mime_to_ext($mimetype)
  1806. {
  1807. $supported = common_config('attachments', 'supported');
  1808. if (is_array($supported)) {
  1809. foreach ($supported as $type => $ext) {
  1810. if ($mimetype === $type) {
  1811. return $ext;
  1812. }
  1813. }
  1814. }
  1815. throw new UnknownMimeExtensionException($mimetype);
  1816. }
  1817. // The MIME "media" is the part before the slash (video in video/webm)
  1818. function common_get_mime_media($type)
  1819. {
  1820. $tmp = explode('/', $type);
  1821. return strtolower($tmp[0]);
  1822. }
  1823. // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
  1824. function common_bare_mime($mimetype)
  1825. {
  1826. $mimetype = mb_strtolower($mimetype);
  1827. if ($semicolon = mb_strpos($mimetype, ';')) {
  1828. $mimetype = mb_substr($mimetype, 0, $semicolon);
  1829. }
  1830. return trim($mimetype);
  1831. }
  1832. function common_mime_type_match($type, $avail)
  1833. {
  1834. if (array_key_exists($type, $avail)) {
  1835. return $type;
  1836. } else {
  1837. $parts = explode('/', $type);
  1838. if (array_key_exists($parts[0] . '/*', $avail)) {
  1839. return $parts[0] . '/*';
  1840. } elseif (array_key_exists('*/*', $avail)) {
  1841. return '*/*';
  1842. } else {
  1843. return null;
  1844. }
  1845. }
  1846. }
  1847. function common_negotiate_type($cprefs, $sprefs)
  1848. {
  1849. $combine = [];
  1850. foreach (array_keys($sprefs) as $type) {
  1851. $parts = explode('/', $type);
  1852. if ($parts[1] != '*') {
  1853. $ckey = common_mime_type_match($type, $cprefs);
  1854. if ($ckey) {
  1855. $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
  1856. }
  1857. }
  1858. }
  1859. foreach (array_keys($cprefs) as $type) {
  1860. $parts = explode('/', $type);
  1861. if ($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
  1862. $skey = common_mime_type_match($type, $sprefs);
  1863. if ($skey) {
  1864. $combine[$type] = $sprefs[$skey] * $cprefs[$type];
  1865. }
  1866. }
  1867. }
  1868. $bestq = 0;
  1869. $besttype = 'text/html';
  1870. foreach (array_keys($combine) as $type) {
  1871. if ($combine[$type] > $bestq) {
  1872. $besttype = $type;
  1873. $bestq = $combine[$type];
  1874. }
  1875. }
  1876. if ('text/html' === $besttype) {
  1877. return "text/html; charset=utf-8";
  1878. }
  1879. return $besttype;
  1880. }
  1881. function common_config($main, $sub=null)
  1882. {
  1883. global $config;
  1884. if (is_null($sub)) {
  1885. // Return the config category array
  1886. return array_key_exists($main, $config) ? $config[$main] : [];
  1887. }
  1888. // Return the config value
  1889. return (array_key_exists($main, $config) &&
  1890. array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
  1891. }
  1892. function common_config_set($main, $sub, $value)
  1893. {
  1894. global $config;
  1895. if (!array_key_exists($main, $config)) {
  1896. $config[$main] = [];
  1897. }
  1898. $config[$main][$sub] = $value;
  1899. }
  1900. function common_config_append($main, $sub, $value)
  1901. {
  1902. global $config;
  1903. if (!array_key_exists($main, $config)) {
  1904. $config[$main] = [];
  1905. }
  1906. if (!array_key_exists($sub, $config[$main])) {
  1907. $config[$main][$sub] = [];
  1908. }
  1909. if (!is_array($config[$main][$sub])) {
  1910. $config[$main][$sub] = [$config[$main][$sub]];
  1911. }
  1912. array_push($config[$main][$sub], $value);
  1913. }
  1914. /**
  1915. * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
  1916. * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
  1917. *
  1918. * @param array $from
  1919. * @return array
  1920. */
  1921. function common_copy_args($from)
  1922. {
  1923. $to = [];
  1924. $strip = get_magic_quotes_gpc();
  1925. foreach ($from as $k => $v) {
  1926. if (is_array($v)) {
  1927. $to[$k] = common_copy_args($v);
  1928. } else {
  1929. if ($strip) {
  1930. $v = stripslashes($v);
  1931. }
  1932. $to[$k] = strval(common_validate_utf8($v));
  1933. }
  1934. }
  1935. return $to;
  1936. }
  1937. /**
  1938. * Neutralise the evil effects of magic_quotes_gpc in the current request.
  1939. * This is used before handing a request off to OAuthRequest::from_request.
  1940. * @fixme Doesn't consider vars other than _POST and _GET?
  1941. * @fixme Can't be undone and could corrupt data if run twice.
  1942. */
  1943. function common_remove_magic_from_request()
  1944. {
  1945. if (get_magic_quotes_gpc()) {
  1946. $_POST=array_map('stripslashes', $_POST);
  1947. $_GET=array_map('stripslashes', $_GET);
  1948. }
  1949. }
  1950. function common_user_uri(&$user)
  1951. {
  1952. return common_local_url('userbyid',
  1953. ['id' => $user->id],
  1954. null,
  1955. null,
  1956. false);
  1957. }
  1958. /**
  1959. * Generates cryptographically secure pseudo-random strings out of a allowed chars string
  1960. *
  1961. * @param $bits int strength of the confirmation code
  1962. * @param $codechars allowed characters to be used in the confirmation code, by default we use 36 upper case
  1963. * alphanums and remove lookalikes (0, O, 1, I) = 32 chars = 5 bits to make it easy for the user to type in
  1964. * @return string confirmation_code of length $bits/5
  1965. */
  1966. function common_confirmation_code($bits, $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ') {
  1967. $chars = ceil($bits/5);
  1968. $codechars_length = strlen($codechars)-1;
  1969. $code = '';
  1970. for($i = 0; $i < $chars; ++$i) {
  1971. $random_char = $codechars[random_int(0, $codechars_length)];
  1972. $code .= $random_char;
  1973. }
  1974. return $code;
  1975. }
  1976. // convert markup to HTML
  1977. function common_markup_to_html($c, $args=null)
  1978. {
  1979. if ($c === null) {
  1980. return '';
  1981. }
  1982. if (is_null($args)) {
  1983. $args = [];
  1984. }
  1985. // XXX: not very efficient
  1986. foreach ($args as $name => $value) {
  1987. $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
  1988. }
  1989. $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) {
  1990. return common_user_property($m[1]);
  1991. }, $c);
  1992. $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) {
  1993. return common_local_url($m[1]);
  1994. }, $c);
  1995. $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) {
  1996. return common_local_url('doc', ['title'=>$m[1]]);
  1997. }, $c);
  1998. $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) {
  1999. return common_config($m[1], $m[2]);
  2000. }, $c);
  2001. return \Michelf\Markdown::defaultTransform($c);
  2002. }
  2003. function common_user_property($property)
  2004. {
  2005. $profile = Profile::current();
  2006. if (empty($profile)) {
  2007. return null;
  2008. }
  2009. switch ($property) {
  2010. case 'profileurl':
  2011. case 'nickname':
  2012. case 'fullname':
  2013. case 'location':
  2014. case 'bio':
  2015. return $profile->$property;
  2016. break;
  2017. case 'avatar':
  2018. try {
  2019. return $profile->getAvatar(AVATAR_STREAM_SIZE);
  2020. } catch (Exception $e) {
  2021. return null;
  2022. }
  2023. break;
  2024. case 'bestname':
  2025. return $profile->getBestName();
  2026. break;
  2027. default:
  2028. return null;
  2029. }
  2030. }
  2031. function common_profile_uri($profile)
  2032. {
  2033. $uri = null;
  2034. if (!empty($profile)) {
  2035. if (Event::handle('StartCommonProfileURI', [$profile, &$uri])) {
  2036. $user = User::getKV('id', $profile->id);
  2037. if ($user instanceof User) {
  2038. $uri = $user->getUri();
  2039. }
  2040. Event::handle('EndCommonProfileURI', [$profile, &$uri]);
  2041. }
  2042. }
  2043. // XXX: this is a very bad profile!
  2044. return $uri;
  2045. }
  2046. function common_canonical_sms($sms)
  2047. {
  2048. // strip non-digits
  2049. preg_replace('/\D/', '', $sms);
  2050. return $sms;
  2051. }
  2052. function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
  2053. {
  2054. switch ($errno) {
  2055. case E_ERROR:
  2056. case E_COMPILE_ERROR:
  2057. case E_CORE_ERROR:
  2058. case E_USER_ERROR:
  2059. case E_PARSE:
  2060. case E_RECOVERABLE_ERROR:
  2061. common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
  2062. die();
  2063. break;
  2064. case E_WARNING:
  2065. case E_COMPILE_WARNING:
  2066. case E_CORE_WARNING:
  2067. case E_USER_WARNING:
  2068. common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
  2069. break;
  2070. case E_NOTICE:
  2071. case E_USER_NOTICE:
  2072. common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
  2073. break;
  2074. case E_STRICT:
  2075. case E_DEPRECATED:
  2076. case E_USER_DEPRECATED:
  2077. // XXX: config variable to log this stuff, too
  2078. break;
  2079. default:
  2080. common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
  2081. die();
  2082. break;
  2083. }
  2084. // FIXME: show error page if we're on the Web
  2085. /* Don't execute PHP internal error handler */
  2086. return true;
  2087. }
  2088. function common_session_token()
  2089. {
  2090. common_ensure_session();
  2091. if (!array_key_exists('token', $_SESSION)) {
  2092. $_SESSION['token'] = common_random_hexstr(64);
  2093. }
  2094. return $_SESSION['token'];
  2095. }
  2096. function common_license_terms($uri)
  2097. {
  2098. if (preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
  2099. return explode('-', $matches[1]);
  2100. }
  2101. return [$uri];
  2102. }
  2103. function common_compatible_license($from, $to)
  2104. {
  2105. $from_terms = common_license_terms($from);
  2106. // public domain and cc-by are compatible with everything
  2107. if (count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
  2108. return true;
  2109. }
  2110. $to_terms = common_license_terms($to);
  2111. // sa is compatible across versions. IANAL
  2112. if (in_array('sa', $from_terms) || in_array('sa', $to_terms)) {
  2113. return count(array_diff($from_terms, $to_terms)) == 0;
  2114. }
  2115. // XXX: better compatibility check needed here!
  2116. // Should at least normalise URIs
  2117. return ($from == $to);
  2118. }
  2119. /**
  2120. * returns a quoted table name, if required according to config
  2121. */
  2122. function common_database_tablename($tablename)
  2123. {
  2124. if (common_config('db', 'quote_identifiers')) {
  2125. $tablename = '"'. $tablename .'"';
  2126. }
  2127. //table prefixes could be added here later
  2128. return $tablename;
  2129. }
  2130. /**
  2131. * Shorten a URL with the current user's configured shortening service,
  2132. * or ur1.ca if configured, or not at all if no shortening is set up.
  2133. *
  2134. * @param string $long_url original URL
  2135. * @param User $user to specify a particular user's options
  2136. * @param boolean $force Force shortening (used when notice is too long)
  2137. * @return string may return the original URL if shortening failed
  2138. *
  2139. * @fixme provide a way to specify a particular shortener
  2140. */
  2141. function common_shorten_url($long_url, User $user=null, $force = false)
  2142. {
  2143. $long_url = trim($long_url);
  2144. $user = common_current_user();
  2145. $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
  2146. // $force forces shortening even if it's not strictly needed
  2147. // I doubt URL shortening is ever 'strictly' needed. - ESP
  2148. if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
  2149. return $long_url;
  2150. }
  2151. $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
  2152. if (Event::handle(
  2153. 'StartShortenUrl',
  2154. [$long_url, $shortenerName, &$shortenedUrl]
  2155. )) {
  2156. if ($shortenerName == 'internal') {
  2157. try {
  2158. $f = File::processNew($long_url);
  2159. $shortenedUrl = common_local_url('redirecturl', ['id' => $f->id]);
  2160. if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
  2161. return $shortenedUrl;
  2162. } else {
  2163. return $long_url;
  2164. }
  2165. } catch (ServerException $e) {
  2166. return $long_url;
  2167. }
  2168. } else {
  2169. return $long_url;
  2170. }
  2171. } else {
  2172. //URL was shortened, so return the result
  2173. return trim($shortenedUrl);
  2174. }
  2175. }
  2176. /**
  2177. * @return mixed array($proxy, $ip) for web requests; proxy may be null
  2178. * null if not a web request
  2179. *
  2180. * @fixme X-Forwarded-For can be chained by multiple proxies;
  2181. we should parse the list and provide a cleaner array
  2182. * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
  2183. * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
  2184. * use function to get exact request headers from Apache if possible.
  2185. */
  2186. function common_client_ip()
  2187. {
  2188. if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
  2189. return null;
  2190. }
  2191. if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
  2192. if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
  2193. $proxy = $_SERVER['HTTP_CLIENT_IP'];
  2194. } else {
  2195. $proxy = $_SERVER['REMOTE_ADDR'];
  2196. }
  2197. $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
  2198. } else {
  2199. $proxy = null;
  2200. if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
  2201. $ip = $_SERVER['HTTP_CLIENT_IP'];
  2202. } else {
  2203. $ip = $_SERVER['REMOTE_ADDR'];
  2204. }
  2205. }
  2206. return [$proxy, $ip];
  2207. }
  2208. function common_url_to_nickname($url)
  2209. {
  2210. static $bad = ['query', 'user', 'password', 'port', 'fragment'];
  2211. $parts = parse_url($url);
  2212. // If any of these parts exist, this won't work
  2213. foreach ($bad as $badpart) {
  2214. if (array_key_exists($badpart, $parts)) {
  2215. return null;
  2216. }
  2217. }
  2218. // We just have host and/or path
  2219. // If it's just a host...
  2220. if (array_key_exists('host', $parts) &&
  2221. (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0)) {
  2222. $hostparts = explode('.', $parts['host']);
  2223. // Try to catch common idiom of nickname.service.tld
  2224. if ((count($hostparts) > 2) &&
  2225. (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
  2226. (strcmp($hostparts[0], 'www') != 0)) {
  2227. return common_nicknamize($hostparts[0]);
  2228. } else {
  2229. // Do the whole hostname
  2230. return common_nicknamize($parts['host']);
  2231. }
  2232. } else {
  2233. if (array_key_exists('path', $parts)) {
  2234. // Strip starting, ending slashes
  2235. $path = preg_replace('@/$@', '', $parts['path']);
  2236. $path = preg_replace('@^/@', '', $path);
  2237. $path = basename($path);
  2238. // Hack for MediaWiki user pages, in the form:
  2239. // http://example.com/wiki/User:Myname
  2240. // ('User' may be localized.)
  2241. if (strpos($path, ':')) {
  2242. $parts = array_filter(explode(':', $path));
  2243. $path = $parts[count($parts) - 1];
  2244. }
  2245. if ($path) {
  2246. return common_nicknamize($path);
  2247. }
  2248. }
  2249. }
  2250. return null;
  2251. }
  2252. function common_nicknamize($str)
  2253. {
  2254. try {
  2255. return Nickname::normalize($str);
  2256. } catch (NicknameException $e) {
  2257. return null;
  2258. }
  2259. }
  2260. function common_perf_counter($key, $val=null)
  2261. {
  2262. global $_perfCounters;
  2263. if (isset($_perfCounters)) {
  2264. if (common_config('site', 'logperf')) {
  2265. if (array_key_exists($key, $_perfCounters)) {
  2266. $_perfCounters[$key][] = $val;
  2267. } else {
  2268. $_perfCounters[$key] = [$val];
  2269. }
  2270. if (common_config('site', 'logperf_detail')) {
  2271. common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
  2272. }
  2273. }
  2274. }
  2275. }
  2276. function common_log_perf_counters()
  2277. {
  2278. if (common_config('site', 'logperf')) {
  2279. global $_startTime, $_perfCounters;
  2280. if (isset($_startTime)) {
  2281. $endTime = microtime(true);
  2282. $diff = round(($endTime - $_startTime) * 1000);
  2283. common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
  2284. }
  2285. $counters = $_perfCounters;
  2286. ksort($counters);
  2287. foreach ($counters as $key => $values) {
  2288. $count = count($values);
  2289. $unique = count(array_unique($values));
  2290. common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
  2291. }
  2292. }
  2293. }
  2294. function common_is_email($str)
  2295. {
  2296. return (strpos($str, '@') !== false);
  2297. }
  2298. function common_init_stats()
  2299. {
  2300. global $_mem, $_ts;
  2301. $_mem = memory_get_usage(true);
  2302. $_ts = microtime(true);
  2303. }
  2304. function common_log_delta($comment=null)
  2305. {
  2306. global $_mem, $_ts;
  2307. $mold = $_mem;
  2308. $told = $_ts;
  2309. $_mem = memory_get_usage(true);
  2310. $_ts = microtime(true);
  2311. $mtotal = $_mem - $mold;
  2312. $ttotal = $_ts - $told;
  2313. if (empty($comment)) {
  2314. $comment = 'Delta';
  2315. }
  2316. common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
  2317. }
  2318. function common_strip_html($html, $trim=true, $save_whitespace=false)
  2319. {
  2320. // first replace <br /> with \n
  2321. $html = preg_replace('/\<(\s*)?br(\s*)?\/?(\s*)?\>/i', "\n", $html);
  2322. // then, unless explicitly avoided, remove excessive whitespace
  2323. if (!$save_whitespace) {
  2324. $html = preg_replace('/\s+/', ' ', $html);
  2325. }
  2326. $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
  2327. return $trim ? trim($text) : $text;
  2328. }
  2329. function html_sprintf()
  2330. {
  2331. $args = func_get_args();
  2332. for ($i=1; $i<count($args); $i++) {
  2333. $args[$i] = htmlspecialchars($args[$i]);
  2334. }
  2335. return call_user_func_array('sprintf', $args);
  2336. }
  2337. function _ve($var)
  2338. {
  2339. return var_export($var, true);
  2340. }