SimplePie.php 95 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319
  1. <?php
  2. /**
  3. * SimplePie
  4. *
  5. * A PHP-Based RSS and Atom Feed Framework.
  6. * Takes the hard work out of managing a complete RSS/Atom solution.
  7. *
  8. * Copyright (c) 2004-2017, Ryan Parman, Sam Sneddon, Ryan McCue, and contributors
  9. * All rights reserved.
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification, are
  12. * permitted provided that the following conditions are met:
  13. *
  14. * * Redistributions of source code must retain the above copyright notice, this list of
  15. * conditions and the following disclaimer.
  16. *
  17. * * Redistributions in binary form must reproduce the above copyright notice, this list
  18. * of conditions and the following disclaimer in the documentation and/or other materials
  19. * provided with the distribution.
  20. *
  21. * * Neither the name of the SimplePie Team nor the names of its contributors may be used
  22. * to endorse or promote products derived from this software without specific prior
  23. * written permission.
  24. *
  25. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
  26. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  27. * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
  28. * AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  32. * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33. * POSSIBILITY OF SUCH DAMAGE.
  34. *
  35. * @package SimplePie
  36. * @version 1.5.5
  37. * @copyright 2004-2017 Ryan Parman, Sam Sneddon, Ryan McCue
  38. * @author Ryan Parman
  39. * @author Sam Sneddon
  40. * @author Ryan McCue
  41. * @link http://simplepie.org/ SimplePie
  42. * @license http://www.opensource.org/licenses/bsd-license.php BSD License
  43. */
  44. /**
  45. * SimplePie Name
  46. */
  47. define('SIMPLEPIE_NAME', 'SimplePie');
  48. /**
  49. * SimplePie Version
  50. */
  51. define('SIMPLEPIE_VERSION', '1.5.5');
  52. /**
  53. * SimplePie Build
  54. * @todo Hardcode for release (there's no need to have to call SimplePie_Misc::get_build() only every load of simplepie.inc)
  55. */
  56. define('SIMPLEPIE_BUILD', gmdate('YmdHis', SimplePie_Misc::get_build()));
  57. /**
  58. * SimplePie Website URL
  59. */
  60. define('SIMPLEPIE_URL', 'http://simplepie.org');
  61. /**
  62. * SimplePie Useragent
  63. * @see SimplePie::set_useragent()
  64. */
  65. define('SIMPLEPIE_USERAGENT', SIMPLEPIE_NAME . '/' . SIMPLEPIE_VERSION . ' (Feed Parser; ' . SIMPLEPIE_URL . '; Allow like Gecko) Build/' . SIMPLEPIE_BUILD);
  66. /**
  67. * SimplePie Linkback
  68. */
  69. define('SIMPLEPIE_LINKBACK', '<a href="' . SIMPLEPIE_URL . '" title="' . SIMPLEPIE_NAME . ' ' . SIMPLEPIE_VERSION . '">' . SIMPLEPIE_NAME . '</a>');
  70. /**
  71. * Use syslog to report HTTP requests done by SimplePie.
  72. * @see SimplePie::set_syslog()
  73. */
  74. define('SIMPLEPIE_SYSLOG', true); //FreshRSS
  75. /**
  76. * No Autodiscovery
  77. * @see SimplePie::set_autodiscovery_level()
  78. */
  79. define('SIMPLEPIE_LOCATOR_NONE', 0);
  80. /**
  81. * Feed Link Element Autodiscovery
  82. * @see SimplePie::set_autodiscovery_level()
  83. */
  84. define('SIMPLEPIE_LOCATOR_AUTODISCOVERY', 1);
  85. /**
  86. * Local Feed Extension Autodiscovery
  87. * @see SimplePie::set_autodiscovery_level()
  88. */
  89. define('SIMPLEPIE_LOCATOR_LOCAL_EXTENSION', 2);
  90. /**
  91. * Local Feed Body Autodiscovery
  92. * @see SimplePie::set_autodiscovery_level()
  93. */
  94. define('SIMPLEPIE_LOCATOR_LOCAL_BODY', 4);
  95. /**
  96. * Remote Feed Extension Autodiscovery
  97. * @see SimplePie::set_autodiscovery_level()
  98. */
  99. define('SIMPLEPIE_LOCATOR_REMOTE_EXTENSION', 8);
  100. /**
  101. * Remote Feed Body Autodiscovery
  102. * @see SimplePie::set_autodiscovery_level()
  103. */
  104. define('SIMPLEPIE_LOCATOR_REMOTE_BODY', 16);
  105. /**
  106. * All Feed Autodiscovery
  107. * @see SimplePie::set_autodiscovery_level()
  108. */
  109. define('SIMPLEPIE_LOCATOR_ALL', 31);
  110. /**
  111. * No known feed type
  112. */
  113. define('SIMPLEPIE_TYPE_NONE', 0);
  114. /**
  115. * RSS 0.90
  116. */
  117. define('SIMPLEPIE_TYPE_RSS_090', 1);
  118. /**
  119. * RSS 0.91 (Netscape)
  120. */
  121. define('SIMPLEPIE_TYPE_RSS_091_NETSCAPE', 2);
  122. /**
  123. * RSS 0.91 (Userland)
  124. */
  125. define('SIMPLEPIE_TYPE_RSS_091_USERLAND', 4);
  126. /**
  127. * RSS 0.91 (both Netscape and Userland)
  128. */
  129. define('SIMPLEPIE_TYPE_RSS_091', 6);
  130. /**
  131. * RSS 0.92
  132. */
  133. define('SIMPLEPIE_TYPE_RSS_092', 8);
  134. /**
  135. * RSS 0.93
  136. */
  137. define('SIMPLEPIE_TYPE_RSS_093', 16);
  138. /**
  139. * RSS 0.94
  140. */
  141. define('SIMPLEPIE_TYPE_RSS_094', 32);
  142. /**
  143. * RSS 1.0
  144. */
  145. define('SIMPLEPIE_TYPE_RSS_10', 64);
  146. /**
  147. * RSS 2.0
  148. */
  149. define('SIMPLEPIE_TYPE_RSS_20', 128);
  150. /**
  151. * RDF-based RSS
  152. */
  153. define('SIMPLEPIE_TYPE_RSS_RDF', 65);
  154. /**
  155. * Non-RDF-based RSS (truly intended as syndication format)
  156. */
  157. define('SIMPLEPIE_TYPE_RSS_SYNDICATION', 190);
  158. /**
  159. * All RSS
  160. */
  161. define('SIMPLEPIE_TYPE_RSS_ALL', 255);
  162. /**
  163. * Atom 0.3
  164. */
  165. define('SIMPLEPIE_TYPE_ATOM_03', 256);
  166. /**
  167. * Atom 1.0
  168. */
  169. define('SIMPLEPIE_TYPE_ATOM_10', 512);
  170. /**
  171. * All Atom
  172. */
  173. define('SIMPLEPIE_TYPE_ATOM_ALL', 768);
  174. /**
  175. * All feed types
  176. */
  177. define('SIMPLEPIE_TYPE_ALL', 1023);
  178. /**
  179. * No construct
  180. */
  181. define('SIMPLEPIE_CONSTRUCT_NONE', 0);
  182. /**
  183. * Text construct
  184. */
  185. define('SIMPLEPIE_CONSTRUCT_TEXT', 1);
  186. /**
  187. * HTML construct
  188. */
  189. define('SIMPLEPIE_CONSTRUCT_HTML', 2);
  190. /**
  191. * XHTML construct
  192. */
  193. define('SIMPLEPIE_CONSTRUCT_XHTML', 4);
  194. /**
  195. * base64-encoded construct
  196. */
  197. define('SIMPLEPIE_CONSTRUCT_BASE64', 8);
  198. /**
  199. * IRI construct
  200. */
  201. define('SIMPLEPIE_CONSTRUCT_IRI', 16);
  202. /**
  203. * A construct that might be HTML
  204. */
  205. define('SIMPLEPIE_CONSTRUCT_MAYBE_HTML', 32);
  206. /**
  207. * All constructs
  208. */
  209. define('SIMPLEPIE_CONSTRUCT_ALL', 63);
  210. /**
  211. * Don't change case
  212. */
  213. define('SIMPLEPIE_SAME_CASE', 1);
  214. /**
  215. * Change to lowercase
  216. */
  217. define('SIMPLEPIE_LOWERCASE', 2);
  218. /**
  219. * Change to uppercase
  220. */
  221. define('SIMPLEPIE_UPPERCASE', 4);
  222. /**
  223. * PCRE for HTML attributes
  224. */
  225. define('SIMPLEPIE_PCRE_HTML_ATTRIBUTE', '((?:[\x09\x0A\x0B\x0C\x0D\x20]+[^\x09\x0A\x0B\x0C\x0D\x20\x2F\x3E][^\x09\x0A\x0B\x0C\x0D\x20\x2F\x3D\x3E]*(?:[\x09\x0A\x0B\x0C\x0D\x20]*=[\x09\x0A\x0B\x0C\x0D\x20]*(?:"(?:[^"]*)"|\'(?:[^\']*)\'|(?:[^\x09\x0A\x0B\x0C\x0D\x20\x22\x27\x3E][^\x09\x0A\x0B\x0C\x0D\x20\x3E]*)?))?)*)[\x09\x0A\x0B\x0C\x0D\x20]*');
  226. /**
  227. * PCRE for XML attributes
  228. */
  229. define('SIMPLEPIE_PCRE_XML_ATTRIBUTE', '((?:\s+(?:(?:[^\s:]+:)?[^\s:]+)\s*=\s*(?:"(?:[^"]*)"|\'(?:[^\']*)\'))*)\s*');
  230. /**
  231. * XML Namespace
  232. */
  233. define('SIMPLEPIE_NAMESPACE_XML', 'http://www.w3.org/XML/1998/namespace');
  234. /**
  235. * Atom 1.0 Namespace
  236. */
  237. define('SIMPLEPIE_NAMESPACE_ATOM_10', 'http://www.w3.org/2005/Atom');
  238. /**
  239. * Atom 0.3 Namespace
  240. */
  241. define('SIMPLEPIE_NAMESPACE_ATOM_03', 'http://purl.org/atom/ns#');
  242. /**
  243. * RDF Namespace
  244. */
  245. define('SIMPLEPIE_NAMESPACE_RDF', 'http://www.w3.org/1999/02/22-rdf-syntax-ns#');
  246. /**
  247. * RSS 0.90 Namespace
  248. */
  249. define('SIMPLEPIE_NAMESPACE_RSS_090', 'http://my.netscape.com/rdf/simple/0.9/');
  250. /**
  251. * RSS 1.0 Namespace
  252. */
  253. define('SIMPLEPIE_NAMESPACE_RSS_10', 'http://purl.org/rss/1.0/');
  254. /**
  255. * RSS 1.0 Content Module Namespace
  256. */
  257. define('SIMPLEPIE_NAMESPACE_RSS_10_MODULES_CONTENT', 'http://purl.org/rss/1.0/modules/content/');
  258. /**
  259. * RSS 2.0 Namespace
  260. * (Stupid, I know, but I'm certain it will confuse people less with support.)
  261. */
  262. define('SIMPLEPIE_NAMESPACE_RSS_20', '');
  263. /**
  264. * DC 1.0 Namespace
  265. */
  266. define('SIMPLEPIE_NAMESPACE_DC_10', 'http://purl.org/dc/elements/1.0/');
  267. /**
  268. * DC 1.1 Namespace
  269. */
  270. define('SIMPLEPIE_NAMESPACE_DC_11', 'http://purl.org/dc/elements/1.1/');
  271. /**
  272. * W3C Basic Geo (WGS84 lat/long) Vocabulary Namespace
  273. */
  274. define('SIMPLEPIE_NAMESPACE_W3C_BASIC_GEO', 'http://www.w3.org/2003/01/geo/wgs84_pos#');
  275. /**
  276. * GeoRSS Namespace
  277. */
  278. define('SIMPLEPIE_NAMESPACE_GEORSS', 'http://www.georss.org/georss');
  279. /**
  280. * Media RSS Namespace
  281. */
  282. define('SIMPLEPIE_NAMESPACE_MEDIARSS', 'http://search.yahoo.com/mrss/');
  283. /**
  284. * Wrong Media RSS Namespace. Caused by a long-standing typo in the spec.
  285. */
  286. define('SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG', 'http://search.yahoo.com/mrss');
  287. /**
  288. * Wrong Media RSS Namespace #2. New namespace introduced in Media RSS 1.5.
  289. */
  290. define('SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG2', 'http://video.search.yahoo.com/mrss');
  291. /**
  292. * Wrong Media RSS Namespace #3. A possible typo of the Media RSS 1.5 namespace.
  293. */
  294. define('SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG3', 'http://video.search.yahoo.com/mrss/');
  295. /**
  296. * Wrong Media RSS Namespace #4. New spec location after the RSS Advisory Board takes it over, but not a valid namespace.
  297. */
  298. define('SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG4', 'http://www.rssboard.org/media-rss');
  299. /**
  300. * Wrong Media RSS Namespace #5. A possible typo of the RSS Advisory Board URL.
  301. */
  302. define('SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG5', 'http://www.rssboard.org/media-rss/');
  303. /**
  304. * iTunes RSS Namespace
  305. */
  306. define('SIMPLEPIE_NAMESPACE_ITUNES', 'http://www.itunes.com/dtds/podcast-1.0.dtd');
  307. /**
  308. * XHTML Namespace
  309. */
  310. define('SIMPLEPIE_NAMESPACE_XHTML', 'http://www.w3.org/1999/xhtml');
  311. /**
  312. * IANA Link Relations Registry
  313. */
  314. define('SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY', 'http://www.iana.org/assignments/relation/');
  315. /**
  316. * No file source
  317. */
  318. define('SIMPLEPIE_FILE_SOURCE_NONE', 0);
  319. /**
  320. * Remote file source
  321. */
  322. define('SIMPLEPIE_FILE_SOURCE_REMOTE', 1);
  323. /**
  324. * Local file source
  325. */
  326. define('SIMPLEPIE_FILE_SOURCE_LOCAL', 2);
  327. /**
  328. * fsockopen() file source
  329. */
  330. define('SIMPLEPIE_FILE_SOURCE_FSOCKOPEN', 4);
  331. /**
  332. * cURL file source
  333. */
  334. define('SIMPLEPIE_FILE_SOURCE_CURL', 8);
  335. /**
  336. * file_get_contents() file source
  337. */
  338. define('SIMPLEPIE_FILE_SOURCE_FILE_GET_CONTENTS', 16);
  339. /**
  340. * SimplePie
  341. *
  342. * @package SimplePie
  343. * @subpackage API
  344. */
  345. class SimplePie
  346. {
  347. /**
  348. * @var array Raw data
  349. * @access private
  350. */
  351. public $data = array();
  352. /**
  353. * @var mixed Error string
  354. * @access private
  355. */
  356. public $error;
  357. /**
  358. * @var object Instance of SimplePie_Sanitize (or other class)
  359. * @see SimplePie::set_sanitize_class()
  360. * @access private
  361. */
  362. public $sanitize;
  363. /**
  364. * @var string SimplePie Useragent
  365. * @see SimplePie::set_useragent()
  366. * @access private
  367. */
  368. public $useragent = SIMPLEPIE_USERAGENT;
  369. /**
  370. * @var string Feed URL
  371. * @see SimplePie::set_feed_url()
  372. * @access private
  373. */
  374. public $feed_url;
  375. /**
  376. * @var string Original feed URL, or new feed URL iff HTTP 301 Moved Permanently
  377. * @see SimplePie::subscribe_url()
  378. * @access private
  379. */
  380. public $permanent_url = null;
  381. /**
  382. * @var object Instance of SimplePie_File to use as a feed
  383. * @see SimplePie::set_file()
  384. * @access private
  385. */
  386. public $file;
  387. /**
  388. * @var string Raw feed data
  389. * @see SimplePie::set_raw_data()
  390. * @access private
  391. */
  392. public $raw_data;
  393. /**
  394. * @var int Timeout for fetching remote files
  395. * @see SimplePie::set_timeout()
  396. * @access private
  397. */
  398. public $timeout = 10;
  399. /**
  400. * @var array Custom curl options
  401. * @see SimplePie::set_curl_options()
  402. * @access private
  403. */
  404. public $curl_options = array();
  405. /**
  406. * @var bool Forces fsockopen() to be used for remote files instead
  407. * of cURL, even if a new enough version is installed
  408. * @see SimplePie::force_fsockopen()
  409. * @access private
  410. */
  411. public $force_fsockopen = false;
  412. /**
  413. * @var bool Force the given data/URL to be treated as a feed no matter what
  414. * it appears like
  415. * @see SimplePie::force_feed()
  416. * @access private
  417. */
  418. public $force_feed = false;
  419. /**
  420. * @var bool Enable/Disable Caching
  421. * @see SimplePie::enable_cache()
  422. * @access private
  423. */
  424. public $cache = true;
  425. /**
  426. * @var bool Force SimplePie to fallback to expired cache, if enabled,
  427. * when feed is unavailable.
  428. * @see SimplePie::force_cache_fallback()
  429. * @access private
  430. */
  431. public $force_cache_fallback = false;
  432. /**
  433. * @var int Cache duration (in seconds)
  434. * @see SimplePie::set_cache_duration()
  435. * @access private
  436. */
  437. public $cache_duration = 3600;
  438. /**
  439. * @var int Auto-discovery cache duration (in seconds)
  440. * @see SimplePie::set_autodiscovery_cache_duration()
  441. * @access private
  442. */
  443. public $autodiscovery_cache_duration = 604800; // 7 Days.
  444. /**
  445. * @var string Cache location (relative to executing script)
  446. * @see SimplePie::set_cache_location()
  447. * @access private
  448. */
  449. public $cache_location = './cache';
  450. /**
  451. * @var string Function that creates the cache filename
  452. * @see SimplePie::set_cache_name_function()
  453. * @access private
  454. */
  455. public $cache_name_function = 'md5';
  456. /**
  457. * @var bool Reorder feed by date descending
  458. * @see SimplePie::enable_order_by_date()
  459. * @access private
  460. */
  461. public $order_by_date = true;
  462. /**
  463. * @var mixed Force input encoding to be set to the follow value
  464. * (false, or anything type-cast to false, disables this feature)
  465. * @see SimplePie::set_input_encoding()
  466. * @access private
  467. */
  468. public $input_encoding = false;
  469. /**
  470. * @var int Feed Autodiscovery Level
  471. * @see SimplePie::set_autodiscovery_level()
  472. * @access private
  473. */
  474. public $autodiscovery = SIMPLEPIE_LOCATOR_ALL;
  475. /**
  476. * Class registry object
  477. *
  478. * @var SimplePie_Registry
  479. */
  480. public $registry;
  481. /**
  482. * @var int Maximum number of feeds to check with autodiscovery
  483. * @see SimplePie::set_max_checked_feeds()
  484. * @access private
  485. */
  486. public $max_checked_feeds = 10;
  487. /**
  488. * @var array All the feeds found during the autodiscovery process
  489. * @see SimplePie::get_all_discovered_feeds()
  490. * @access private
  491. */
  492. public $all_discovered_feeds = array();
  493. /**
  494. * @var string Web-accessible path to the handler_image.php file.
  495. * @see SimplePie::set_image_handler()
  496. * @access private
  497. */
  498. public $image_handler = '';
  499. /**
  500. * @var array Stores the URLs when multiple feeds are being initialized.
  501. * @see SimplePie::set_feed_url()
  502. * @access private
  503. */
  504. public $multifeed_url = array();
  505. /**
  506. * @var array Stores SimplePie objects when multiple feeds initialized.
  507. * @access private
  508. */
  509. public $multifeed_objects = array();
  510. /**
  511. * @var array Stores the get_object_vars() array for use with multifeeds.
  512. * @see SimplePie::set_feed_url()
  513. * @access private
  514. */
  515. public $config_settings = null;
  516. /**
  517. * @var integer Stores the number of items to return per-feed with multifeeds.
  518. * @see SimplePie::set_item_limit()
  519. * @access private
  520. */
  521. public $item_limit = 0;
  522. /**
  523. * @var bool Stores if last-modified and/or etag headers were sent with the
  524. * request when checking a feed.
  525. */
  526. public $check_modified = false;
  527. /**
  528. * @var array Stores the default attributes to be stripped by strip_attributes().
  529. * @see SimplePie::strip_attributes()
  530. * @access private
  531. */
  532. public $strip_attributes = array('bgsound', 'class', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc');
  533. /**
  534. * @var array Stores the default attributes to add to different tags by add_attributes().
  535. * @see SimplePie::add_attributes()
  536. * @access private
  537. */
  538. public $add_attributes = array('audio' => array('preload' => 'none'), 'iframe' => array('sandbox' => 'allow-scripts allow-same-origin'), 'video' => array('preload' => 'none'));
  539. /**
  540. * @var array Stores the default tags to be stripped by strip_htmltags().
  541. * @see SimplePie::strip_htmltags()
  542. * @access private
  543. */
  544. public $strip_htmltags = array('base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style');
  545. /**
  546. * @var bool Should we throw exceptions, or use the old-style error property?
  547. * @access private
  548. */
  549. public $enable_exceptions = false;
  550. /**
  551. * Use syslog to report HTTP requests done by SimplePie.
  552. * @see SimplePie::set_syslog()
  553. */
  554. public $syslog_enabled = SIMPLEPIE_SYSLOG;
  555. /**
  556. * The SimplePie class contains feed level data and options
  557. *
  558. * To use SimplePie, create the SimplePie object with no parameters. You can
  559. * then set configuration options using the provided methods. After setting
  560. * them, you must initialise the feed using $feed->init(). At that point the
  561. * object's methods and properties will be available to you.
  562. *
  563. * Previously, it was possible to pass in the feed URL along with cache
  564. * options directly into the constructor. This has been removed as of 1.3 as
  565. * it caused a lot of confusion.
  566. *
  567. * @since 1.0 Preview Release
  568. */
  569. public function __construct()
  570. {
  571. if (version_compare(PHP_VERSION, '5.6', '<'))
  572. {
  573. trigger_error('Please upgrade to PHP 5.6 or newer.');
  574. die();
  575. }
  576. // Other objects, instances created here so we can set options on them
  577. $this->sanitize = new SimplePie_Sanitize();
  578. $this->registry = new SimplePie_Registry();
  579. if (func_num_args() > 0)
  580. {
  581. $level = defined('E_USER_DEPRECATED') ? E_USER_DEPRECATED : E_USER_WARNING;
  582. trigger_error('Passing parameters to the constructor is no longer supported. Please use set_feed_url(), set_cache_location(), and set_cache_duration() directly.', $level);
  583. $args = func_get_args();
  584. switch (count($args)) {
  585. case 3:
  586. $this->set_cache_duration($args[2]);
  587. case 2:
  588. $this->set_cache_location($args[1]);
  589. case 1:
  590. $this->set_feed_url($args[0]);
  591. $this->init();
  592. }
  593. }
  594. }
  595. /**
  596. * Used for converting object to a string
  597. */
  598. public function __toString()
  599. {
  600. return md5(serialize($this->data));
  601. }
  602. /**
  603. * Remove items that link back to this before destroying this object
  604. */
  605. public function __destruct()
  606. {
  607. if (!gc_enabled())
  608. {
  609. if (!empty($this->data['items']))
  610. {
  611. foreach ($this->data['items'] as $item)
  612. {
  613. $item->__destruct();
  614. }
  615. unset($item, $this->data['items']);
  616. }
  617. if (!empty($this->data['ordered_items']))
  618. {
  619. foreach ($this->data['ordered_items'] as $item)
  620. {
  621. $item->__destruct();
  622. }
  623. unset($item, $this->data['ordered_items']);
  624. }
  625. }
  626. }
  627. /**
  628. * Force the given data/URL to be treated as a feed
  629. *
  630. * This tells SimplePie to ignore the content-type provided by the server.
  631. * Be careful when using this option, as it will also disable autodiscovery.
  632. *
  633. * @since 1.1
  634. * @param bool $enable Force the given data/URL to be treated as a feed
  635. */
  636. public function force_feed($enable = false)
  637. {
  638. $this->force_feed = (bool) $enable;
  639. }
  640. /**
  641. * Set the URL of the feed you want to parse
  642. *
  643. * This allows you to enter the URL of the feed you want to parse, or the
  644. * website you want to try to use auto-discovery on. This takes priority
  645. * over any set raw data.
  646. *
  647. * You can set multiple feeds to mash together by passing an array instead
  648. * of a string for the $url. Remember that with each additional feed comes
  649. * additional processing and resources.
  650. *
  651. * @since 1.0 Preview Release
  652. * @see set_raw_data()
  653. * @param string|array $url This is the URL (or array of URLs) that you want to parse.
  654. */
  655. public function set_feed_url($url)
  656. {
  657. $this->multifeed_url = array();
  658. if (is_array($url))
  659. {
  660. foreach ($url as $value)
  661. {
  662. $this->multifeed_url[] = $this->registry->call('Misc', 'fix_protocol', array($value, 1));
  663. }
  664. }
  665. else
  666. {
  667. $this->feed_url = $this->registry->call('Misc', 'fix_protocol', array($url, 1));
  668. $this->permanent_url = $this->feed_url;
  669. }
  670. }
  671. /**
  672. * Set an instance of {@see SimplePie_File} to use as a feed
  673. *
  674. * @param SimplePie_File &$file
  675. * @return bool True on success, false on failure
  676. */
  677. public function set_file(&$file)
  678. {
  679. if ($file instanceof SimplePie_File)
  680. {
  681. $this->feed_url = $file->url;
  682. $this->permanent_url = $this->feed_url;
  683. $this->file =& $file;
  684. return true;
  685. }
  686. return false;
  687. }
  688. /**
  689. * Set the raw XML data to parse
  690. *
  691. * Allows you to use a string of RSS/Atom data instead of a remote feed.
  692. *
  693. * If you have a feed available as a string in PHP, you can tell SimplePie
  694. * to parse that data string instead of a remote feed. Any set feed URL
  695. * takes precedence.
  696. *
  697. * @since 1.0 Beta 3
  698. * @param string $data RSS or Atom data as a string.
  699. * @see set_feed_url()
  700. */
  701. public function set_raw_data($data)
  702. {
  703. $this->raw_data = $data;
  704. }
  705. /**
  706. * Set the default timeout for fetching remote feeds
  707. *
  708. * This allows you to change the maximum time the feed's server to respond
  709. * and send the feed back.
  710. *
  711. * @since 1.0 Beta 3
  712. * @param int $timeout The maximum number of seconds to spend waiting to retrieve a feed.
  713. */
  714. public function set_timeout($timeout = 10)
  715. {
  716. $this->timeout = (int) $timeout;
  717. }
  718. /**
  719. * Set custom curl options
  720. *
  721. * This allows you to change default curl options
  722. *
  723. * @since 1.0 Beta 3
  724. * @param array $curl_options Curl options to add to default settings
  725. */
  726. public function set_curl_options(array $curl_options = array())
  727. {
  728. $this->curl_options = $curl_options;
  729. }
  730. /**
  731. * Force SimplePie to use fsockopen() instead of cURL
  732. *
  733. * @since 1.0 Beta 3
  734. * @param bool $enable Force fsockopen() to be used
  735. */
  736. public function force_fsockopen($enable = false)
  737. {
  738. $this->force_fsockopen = (bool) $enable;
  739. }
  740. /**
  741. * Enable/disable caching in SimplePie.
  742. *
  743. * This option allows you to disable caching all-together in SimplePie.
  744. * However, disabling the cache can lead to longer load times.
  745. *
  746. * @since 1.0 Preview Release
  747. * @param bool $enable Enable caching
  748. */
  749. public function enable_cache($enable = true)
  750. {
  751. $this->cache = (bool) $enable;
  752. }
  753. /**
  754. * SimplePie to continue to fall back to expired cache, if enabled, when
  755. * feed is unavailable.
  756. *
  757. * This tells SimplePie to ignore any file errors and fall back to cache
  758. * instead. This only works if caching is enabled and cached content
  759. * still exists.
  760. * @param bool $enable Force use of cache on fail.
  761. */
  762. public function force_cache_fallback($enable = false)
  763. {
  764. $this->force_cache_fallback= (bool) $enable;
  765. }
  766. /**
  767. * Set the length of time (in seconds) that the contents of a feed will be
  768. * cached
  769. *
  770. * @param int $seconds The feed content cache duration
  771. */
  772. public function set_cache_duration($seconds = 3600)
  773. {
  774. $this->cache_duration = (int) $seconds;
  775. }
  776. /**
  777. * Set the length of time (in seconds) that the autodiscovered feed URL will
  778. * be cached
  779. *
  780. * @param int $seconds The autodiscovered feed URL cache duration.
  781. */
  782. public function set_autodiscovery_cache_duration($seconds = 604800)
  783. {
  784. $this->autodiscovery_cache_duration = (int) $seconds;
  785. }
  786. /**
  787. * Set the file system location where the cached files should be stored
  788. *
  789. * @param string $location The file system location.
  790. */
  791. public function set_cache_location($location = './cache')
  792. {
  793. $this->cache_location = (string) $location;
  794. }
  795. /**
  796. * Set whether feed items should be sorted into reverse chronological order
  797. *
  798. * @param bool $enable Sort as reverse chronological order.
  799. */
  800. public function enable_order_by_date($enable = true)
  801. {
  802. $this->order_by_date = (bool) $enable;
  803. }
  804. /**
  805. * Set the character encoding used to parse the feed
  806. *
  807. * This overrides the encoding reported by the feed, however it will fall
  808. * back to the normal encoding detection if the override fails
  809. *
  810. * @param string $encoding Character encoding
  811. */
  812. public function set_input_encoding($encoding = false)
  813. {
  814. if ($encoding)
  815. {
  816. $this->input_encoding = (string) $encoding;
  817. }
  818. else
  819. {
  820. $this->input_encoding = false;
  821. }
  822. }
  823. /**
  824. * Set how much feed autodiscovery to do
  825. *
  826. * @see SIMPLEPIE_LOCATOR_NONE
  827. * @see SIMPLEPIE_LOCATOR_AUTODISCOVERY
  828. * @see SIMPLEPIE_LOCATOR_LOCAL_EXTENSION
  829. * @see SIMPLEPIE_LOCATOR_LOCAL_BODY
  830. * @see SIMPLEPIE_LOCATOR_REMOTE_EXTENSION
  831. * @see SIMPLEPIE_LOCATOR_REMOTE_BODY
  832. * @see SIMPLEPIE_LOCATOR_ALL
  833. * @param int $level Feed Autodiscovery Level (level can be a combination of the above constants, see bitwise OR operator)
  834. */
  835. public function set_autodiscovery_level($level = SIMPLEPIE_LOCATOR_ALL)
  836. {
  837. $this->autodiscovery = (int) $level;
  838. }
  839. /**
  840. * Get the class registry
  841. *
  842. * Use this to override SimplePie's default classes
  843. * @see SimplePie_Registry
  844. * @return SimplePie_Registry
  845. */
  846. public function &get_registry()
  847. {
  848. return $this->registry;
  849. }
  850. /**#@+
  851. * Useful when you are overloading or extending SimplePie's default classes.
  852. *
  853. * @deprecated Use {@see get_registry()} instead
  854. * @link http://php.net/manual/en/language.oop5.basic.php#language.oop5.basic.extends PHP5 extends documentation
  855. * @param string $class Name of custom class
  856. * @return boolean True on success, false otherwise
  857. */
  858. /**
  859. * Set which class SimplePie uses for caching
  860. */
  861. public function set_cache_class($class = 'SimplePie_Cache')
  862. {
  863. return $this->registry->register('Cache', $class, true);
  864. }
  865. /**
  866. * Set which class SimplePie uses for auto-discovery
  867. */
  868. public function set_locator_class($class = 'SimplePie_Locator')
  869. {
  870. return $this->registry->register('Locator', $class, true);
  871. }
  872. /**
  873. * Set which class SimplePie uses for XML parsing
  874. */
  875. public function set_parser_class($class = 'SimplePie_Parser')
  876. {
  877. return $this->registry->register('Parser', $class, true);
  878. }
  879. /**
  880. * Set which class SimplePie uses for remote file fetching
  881. */
  882. public function set_file_class($class = 'SimplePie_File')
  883. {
  884. return $this->registry->register('File', $class, true);
  885. }
  886. /**
  887. * Set which class SimplePie uses for data sanitization
  888. */
  889. public function set_sanitize_class($class = 'SimplePie_Sanitize')
  890. {
  891. return $this->registry->register('Sanitize', $class, true);
  892. }
  893. /**
  894. * Set which class SimplePie uses for handling feed items
  895. */
  896. public function set_item_class($class = 'SimplePie_Item')
  897. {
  898. return $this->registry->register('Item', $class, true);
  899. }
  900. /**
  901. * Set which class SimplePie uses for handling author data
  902. */
  903. public function set_author_class($class = 'SimplePie_Author')
  904. {
  905. return $this->registry->register('Author', $class, true);
  906. }
  907. /**
  908. * Set which class SimplePie uses for handling category data
  909. */
  910. public function set_category_class($class = 'SimplePie_Category')
  911. {
  912. return $this->registry->register('Category', $class, true);
  913. }
  914. /**
  915. * Set which class SimplePie uses for feed enclosures
  916. */
  917. public function set_enclosure_class($class = 'SimplePie_Enclosure')
  918. {
  919. return $this->registry->register('Enclosure', $class, true);
  920. }
  921. /**
  922. * Set which class SimplePie uses for `<media:text>` captions
  923. */
  924. public function set_caption_class($class = 'SimplePie_Caption')
  925. {
  926. return $this->registry->register('Caption', $class, true);
  927. }
  928. /**
  929. * Set which class SimplePie uses for `<media:copyright>`
  930. */
  931. public function set_copyright_class($class = 'SimplePie_Copyright')
  932. {
  933. return $this->registry->register('Copyright', $class, true);
  934. }
  935. /**
  936. * Set which class SimplePie uses for `<media:credit>`
  937. */
  938. public function set_credit_class($class = 'SimplePie_Credit')
  939. {
  940. return $this->registry->register('Credit', $class, true);
  941. }
  942. /**
  943. * Set which class SimplePie uses for `<media:rating>`
  944. */
  945. public function set_rating_class($class = 'SimplePie_Rating')
  946. {
  947. return $this->registry->register('Rating', $class, true);
  948. }
  949. /**
  950. * Set which class SimplePie uses for `<media:restriction>`
  951. */
  952. public function set_restriction_class($class = 'SimplePie_Restriction')
  953. {
  954. return $this->registry->register('Restriction', $class, true);
  955. }
  956. /**
  957. * Set which class SimplePie uses for content-type sniffing
  958. */
  959. public function set_content_type_sniffer_class($class = 'SimplePie_Content_Type_Sniffer')
  960. {
  961. return $this->registry->register('Content_Type_Sniffer', $class, true);
  962. }
  963. /**
  964. * Set which class SimplePie uses item sources
  965. */
  966. public function set_source_class($class = 'SimplePie_Source')
  967. {
  968. return $this->registry->register('Source', $class, true);
  969. }
  970. /**#@-*/
  971. /**
  972. * Set the user agent string
  973. *
  974. * @param string $ua New user agent string.
  975. */
  976. public function set_useragent($ua = SIMPLEPIE_USERAGENT)
  977. {
  978. $this->useragent = (string) $ua;
  979. }
  980. /**
  981. * Set callback function to create cache filename with
  982. *
  983. * @param mixed $function Callback function
  984. */
  985. public function set_cache_name_function($function = 'md5')
  986. {
  987. if (is_callable($function))
  988. {
  989. $this->cache_name_function = $function;
  990. }
  991. }
  992. /**
  993. * Set options to make SP as fast as possible
  994. *
  995. * Forgoes a substantial amount of data sanitization in favor of speed. This
  996. * turns SimplePie into a dumb parser of feeds.
  997. *
  998. * @param bool $set Whether to set them or not
  999. */
  1000. public function set_stupidly_fast($set = false)
  1001. {
  1002. if ($set)
  1003. {
  1004. $this->enable_order_by_date(false);
  1005. $this->remove_div(false);
  1006. $this->strip_comments(false);
  1007. $this->strip_htmltags(false);
  1008. $this->strip_attributes(false);
  1009. $this->add_attributes(false);
  1010. $this->set_image_handler(false);
  1011. $this->set_https_domains(array());
  1012. }
  1013. }
  1014. /**
  1015. * Set maximum number of feeds to check with autodiscovery
  1016. *
  1017. * @param int $max Maximum number of feeds to check
  1018. */
  1019. public function set_max_checked_feeds($max = 10)
  1020. {
  1021. $this->max_checked_feeds = (int) $max;
  1022. }
  1023. public function remove_div($enable = true)
  1024. {
  1025. $this->sanitize->remove_div($enable);
  1026. }
  1027. public function strip_htmltags($tags = '', $encode = null)
  1028. {
  1029. if ($tags === '')
  1030. {
  1031. $tags = $this->strip_htmltags;
  1032. }
  1033. $this->sanitize->strip_htmltags($tags);
  1034. if ($encode !== null)
  1035. {
  1036. $this->sanitize->encode_instead_of_strip($tags);
  1037. }
  1038. }
  1039. public function encode_instead_of_strip($enable = true)
  1040. {
  1041. $this->sanitize->encode_instead_of_strip($enable);
  1042. }
  1043. public function strip_attributes($attribs = '')
  1044. {
  1045. if ($attribs === '')
  1046. {
  1047. $attribs = $this->strip_attributes;
  1048. }
  1049. $this->sanitize->strip_attributes($attribs);
  1050. }
  1051. public function add_attributes($attribs = '')
  1052. {
  1053. if ($attribs === '')
  1054. {
  1055. $attribs = $this->add_attributes;
  1056. }
  1057. $this->sanitize->add_attributes($attribs);
  1058. }
  1059. /**
  1060. * Use syslog to report HTTP requests done by SimplePie.
  1061. */
  1062. public function set_syslog($value = SIMPLEPIE_SYSLOG) //FreshRSS
  1063. {
  1064. $this->syslog_enabled = $value == true;
  1065. }
  1066. /**
  1067. * Set the output encoding
  1068. *
  1069. * Allows you to override SimplePie's output to match that of your webpage.
  1070. * This is useful for times when your webpages are not being served as
  1071. * UTF-8. This setting will be obeyed by {@see handle_content_type()}, and
  1072. * is similar to {@see set_input_encoding()}.
  1073. *
  1074. * It should be noted, however, that not all character encodings can support
  1075. * all characters. If your page is being served as ISO-8859-1 and you try
  1076. * to display a Japanese feed, you'll likely see garbled characters.
  1077. * Because of this, it is highly recommended to ensure that your webpages
  1078. * are served as UTF-8.
  1079. *
  1080. * The number of supported character encodings depends on whether your web
  1081. * host supports {@link http://php.net/mbstring mbstring},
  1082. * {@link http://php.net/iconv iconv}, or both. See
  1083. * {@link http://simplepie.org/wiki/faq/Supported_Character_Encodings} for
  1084. * more information.
  1085. *
  1086. * @param string $encoding
  1087. */
  1088. public function set_output_encoding($encoding = 'UTF-8')
  1089. {
  1090. $this->sanitize->set_output_encoding($encoding);
  1091. }
  1092. public function strip_comments($strip = false)
  1093. {
  1094. $this->sanitize->strip_comments($strip);
  1095. }
  1096. /**
  1097. * Set element/attribute key/value pairs of HTML attributes
  1098. * containing URLs that need to be resolved relative to the feed
  1099. *
  1100. * Defaults to |a|@href, |area|@href, |blockquote|@cite, |del|@cite,
  1101. * |form|@action, |img|@longdesc, |img|@src, |input|@src, |ins|@cite,
  1102. * |q|@cite
  1103. *
  1104. * @since 1.0
  1105. * @param array|null $element_attribute Element/attribute key/value pairs, null for default
  1106. */
  1107. public function set_url_replacements($element_attribute = null)
  1108. {
  1109. $this->sanitize->set_url_replacements($element_attribute);
  1110. }
  1111. /**
  1112. * Set the list of domains for which force HTTPS.
  1113. * @see SimplePie_Sanitize::set_https_domains()
  1114. * FreshRSS
  1115. */
  1116. public function set_https_domains($domains = array())
  1117. {
  1118. if (is_array($domains))
  1119. {
  1120. $this->sanitize->set_https_domains($domains);
  1121. }
  1122. }
  1123. /**
  1124. * Set the handler to enable the display of cached images.
  1125. *
  1126. * @param string $page Web-accessible path to the handler_image.php file.
  1127. * @param string $qs The query string that the value should be passed to.
  1128. */
  1129. public function set_image_handler($page = false, $qs = 'i')
  1130. {
  1131. if ($page !== false)
  1132. {
  1133. $this->sanitize->set_image_handler($page . '?' . $qs . '=');
  1134. }
  1135. else
  1136. {
  1137. $this->image_handler = '';
  1138. }
  1139. }
  1140. /**
  1141. * Set the limit for items returned per-feed with multifeeds
  1142. *
  1143. * @param integer $limit The maximum number of items to return.
  1144. */
  1145. public function set_item_limit($limit = 0)
  1146. {
  1147. $this->item_limit = (int) $limit;
  1148. }
  1149. /**
  1150. * Enable throwing exceptions
  1151. *
  1152. * @param boolean $enable Should we throw exceptions, or use the old-style error property?
  1153. */
  1154. public function enable_exceptions($enable = true)
  1155. {
  1156. $this->enable_exceptions = $enable;
  1157. }
  1158. function cleanMd5($rss)
  1159. {
  1160. //Process by chunks not to use too much memory
  1161. if (($stream = fopen('php://temp', 'r+')) &&
  1162. fwrite($stream, $rss) &&
  1163. rewind($stream))
  1164. {
  1165. $ctx = hash_init('md5');
  1166. while ($stream_data = fread($stream, 1048576))
  1167. {
  1168. hash_update($ctx, preg_replace([
  1169. '#<(lastBuildDate|pubDate|updated|feedDate|dc:date|slash:comments)>[^<]+</\\1>#',
  1170. '#<(media:starRating|media:statistics) [^/<>]+/>#',
  1171. '#<!--.+?-->#s',
  1172. ], '', $stream_data));
  1173. }
  1174. fclose($stream);
  1175. return hash_final($ctx);
  1176. }
  1177. return '';
  1178. }
  1179. /**
  1180. * Initialize the feed object
  1181. *
  1182. * This is what makes everything happen. Period. This is where all of the
  1183. * configuration options get processed, feeds are fetched, cached, and
  1184. * parsed, and all of that other good stuff.
  1185. *
  1186. * @return positive integer with modification time if using cache, boolean true if otherwise successful, false otherwise
  1187. */
  1188. public function init()
  1189. {
  1190. // Check absolute bare minimum requirements.
  1191. if (!extension_loaded('xml') || !extension_loaded('pcre'))
  1192. {
  1193. $this->error = 'XML or PCRE extensions not loaded!';
  1194. return false;
  1195. }
  1196. // Then check the xml extension is sane (i.e., libxml 2.7.x issue on PHP < 5.2.9 and libxml 2.7.0 to 2.7.2 on any version) if we don't have xmlreader.
  1197. elseif (!extension_loaded('xmlreader'))
  1198. {
  1199. static $xml_is_sane = null;
  1200. if ($xml_is_sane === null)
  1201. {
  1202. $parser_check = xml_parser_create();
  1203. xml_parse_into_struct($parser_check, '<foo>&amp;</foo>', $values);
  1204. xml_parser_free($parser_check);
  1205. $xml_is_sane = isset($values[0]['value']);
  1206. }
  1207. if (!$xml_is_sane)
  1208. {
  1209. return false;
  1210. }
  1211. }
  1212. // The default sanitize class gets set in the constructor, check if it has
  1213. // changed.
  1214. if ($this->registry->get_class('Sanitize') !== 'SimplePie_Sanitize') {
  1215. $this->sanitize = $this->registry->create('Sanitize');
  1216. }
  1217. if (method_exists($this->sanitize, 'set_registry'))
  1218. {
  1219. $this->sanitize->set_registry($this->registry);
  1220. }
  1221. // Pass whatever was set with config options over to the sanitizer.
  1222. // Pass the classes in for legacy support; new classes should use the registry instead
  1223. $this->sanitize->pass_cache_data($this->cache, $this->cache_location, $this->cache_name_function, $this->registry->get_class('Cache'));
  1224. $this->sanitize->pass_file_data($this->registry->get_class('File'), $this->timeout, $this->useragent, $this->force_fsockopen, $this->curl_options);
  1225. if (!empty($this->multifeed_url))
  1226. {
  1227. $i = 0;
  1228. $success = 0;
  1229. $this->multifeed_objects = array();
  1230. $this->error = array();
  1231. foreach ($this->multifeed_url as $url)
  1232. {
  1233. $this->multifeed_objects[$i] = clone $this;
  1234. $this->multifeed_objects[$i]->set_feed_url($url);
  1235. $single_success = $this->multifeed_objects[$i]->init();
  1236. $success |= $single_success;
  1237. if (!$single_success)
  1238. {
  1239. $this->error[$i] = $this->multifeed_objects[$i]->error();
  1240. }
  1241. $i++;
  1242. }
  1243. return (bool) $success;
  1244. }
  1245. elseif ($this->feed_url === null && $this->raw_data === null)
  1246. {
  1247. return false;
  1248. }
  1249. $this->error = null;
  1250. $this->data = array();
  1251. $this->check_modified = false;
  1252. $this->multifeed_objects = array();
  1253. $cache = false;
  1254. if ($this->feed_url !== null)
  1255. {
  1256. $parsed_feed_url = $this->registry->call('Misc', 'parse_url', array($this->feed_url));
  1257. // Decide whether to enable caching
  1258. if ($this->cache && $parsed_feed_url['scheme'] !== '')
  1259. {
  1260. $url = $this->feed_url . ($this->force_feed ? '#force_feed' : '');
  1261. $cache = $this->registry->call('Cache', 'get_handler', array($this->cache_location, call_user_func($this->cache_name_function, $url), 'spc'));
  1262. }
  1263. // Fetch the data via SimplePie_File into $this->raw_data
  1264. if (($fetched = $this->fetch_data($cache)) === true)
  1265. {
  1266. return empty($this->data['mtime']) ? false : $this->data['mtime'];
  1267. }
  1268. elseif ($fetched === false) {
  1269. return false;
  1270. }
  1271. list($headers, $sniffed) = $fetched;
  1272. if (isset($this->data['md5']))
  1273. {
  1274. $md5 = $this->data['md5'];
  1275. }
  1276. }
  1277. // Empty response check
  1278. if(empty($this->raw_data)){
  1279. $this->error = "A feed could not be found at `$this->feed_url`. Empty body.";
  1280. $this->registry->call('Misc', 'error', array($this->error, E_USER_NOTICE, __FILE__, __LINE__));
  1281. return false;
  1282. }
  1283. // Set up array of possible encodings
  1284. $encodings = array();
  1285. // First check to see if input has been overridden.
  1286. if ($this->input_encoding !== false)
  1287. {
  1288. $encodings[] = strtoupper($this->input_encoding);
  1289. }
  1290. $application_types = array('application/xml', 'application/xml-dtd', 'application/xml-external-parsed-entity');
  1291. $text_types = array('text/xml', 'text/xml-external-parsed-entity');
  1292. // RFC 3023 (only applies to sniffed content)
  1293. if (isset($sniffed))
  1294. {
  1295. if (in_array($sniffed, $application_types) || substr($sniffed, 0, 12) === 'application/' && substr($sniffed, -4) === '+xml')
  1296. {
  1297. if (isset($headers['content-type']) && preg_match('/;\x20?charset=([^;]*)/i', $headers['content-type'], $charset))
  1298. {
  1299. $encodings[] = strtoupper($charset[1]);
  1300. }
  1301. else
  1302. {
  1303. $encodings[] = ''; //FreshRSS: Let the DOM parser decide first
  1304. }
  1305. }
  1306. elseif (in_array($sniffed, $text_types) || substr($sniffed, 0, 5) === 'text/' && substr($sniffed, -4) === '+xml')
  1307. {
  1308. if (isset($headers['content-type']) && preg_match('/;\x20?charset=([^;]*)/i', $headers['content-type'], $charset))
  1309. {
  1310. $encodings[] = strtoupper($charset[1]);
  1311. }
  1312. else
  1313. {
  1314. $encodings[] = ''; //FreshRSS: Let the DOM parser decide first
  1315. }
  1316. $encodings[] = 'US-ASCII';
  1317. }
  1318. // Text MIME-type default
  1319. elseif (substr($sniffed, 0, 5) === 'text/')
  1320. {
  1321. $encodings[] = 'UTF-8';
  1322. }
  1323. }
  1324. // Fallback to XML 1.0 Appendix F.1/UTF-8/ISO-8859-1
  1325. $encodings = array_merge($encodings, $this->registry->call('Misc', 'xml_encoding', array($this->raw_data, &$this->registry)));
  1326. $encodings[] = 'UTF-8';
  1327. $encodings[] = 'ISO-8859-1';
  1328. // There's no point in trying an encoding twice
  1329. $encodings = array_unique($encodings);
  1330. // Loop through each possible encoding, till we return something, or run out of possibilities
  1331. foreach ($encodings as $encoding)
  1332. {
  1333. // Change the encoding to UTF-8 (as we always use UTF-8 internally)
  1334. if ($utf8_data = (empty($encoding) || $encoding === 'UTF-8') ? $this->raw_data : //FreshRSS
  1335. $this->registry->call('Misc', 'change_encoding', array($this->raw_data, $encoding, 'UTF-8')))
  1336. {
  1337. // Create new parser
  1338. $parser = $this->registry->create('Parser');
  1339. // If it's parsed fine
  1340. if ($parser->parse($utf8_data, empty($encoding) ? '' : 'UTF-8')) //FreshRSS
  1341. {
  1342. $this->data = $parser->get_data();
  1343. if (!($this->get_type() & ~SIMPLEPIE_TYPE_NONE))
  1344. {
  1345. $this->error = "A feed could not be found at `$this->feed_url`. This does not appear to be a valid RSS or Atom feed.";
  1346. $this->registry->call('Misc', 'error', array($this->error, E_USER_NOTICE, __FILE__, __LINE__));
  1347. return false;
  1348. }
  1349. if (isset($headers))
  1350. {
  1351. $this->data['headers'] = $headers;
  1352. }
  1353. $this->data['build'] = SIMPLEPIE_BUILD;
  1354. $this->data['mtime'] = time();
  1355. $this->data['md5'] = empty($md5) ? $this->cleanMd5($this->raw_data) : $md5;
  1356. // Cache the file if caching is enabled
  1357. if ($cache && !$cache->save($this))
  1358. {
  1359. trigger_error("$this->cache_location is not writable. Make sure you've set the correct relative or absolute path, and that the location is server-writable.", E_USER_WARNING);
  1360. }
  1361. return true;
  1362. }
  1363. }
  1364. }
  1365. if (isset($parser))
  1366. {
  1367. // We have an error, just set SimplePie_Misc::error to it and quit
  1368. $this->error = $this->feed_url;
  1369. $this->error .= sprintf(' is invalid XML, likely due to invalid characters. XML error: %s at line %d, column %d', $parser->get_error_string(), $parser->get_current_line(), $parser->get_current_column());
  1370. }
  1371. else
  1372. {
  1373. $this->error = 'The data could not be converted to UTF-8.';
  1374. if (!extension_loaded('mbstring') && !extension_loaded('iconv') && !class_exists('\UConverter')) {
  1375. $this->error .= ' You MUST have either the iconv, mbstring or intl (PHP 5.5+) extension installed and enabled.';
  1376. } else {
  1377. $missingExtensions = array();
  1378. if (!extension_loaded('iconv')) {
  1379. $missingExtensions[] = 'iconv';
  1380. }
  1381. if (!extension_loaded('mbstring')) {
  1382. $missingExtensions[] = 'mbstring';
  1383. }
  1384. if (!class_exists('\UConverter')) {
  1385. $missingExtensions[] = 'intl (PHP 5.5+)';
  1386. }
  1387. $this->error .= ' Try installing/enabling the ' . implode(' or ', $missingExtensions) . ' extension.';
  1388. }
  1389. }
  1390. $this->registry->call('Misc', 'error', array($this->error, E_USER_NOTICE, __FILE__, __LINE__));
  1391. return false;
  1392. }
  1393. /**
  1394. * Fetch the data via SimplePie_File
  1395. *
  1396. * If the data is already cached, attempt to fetch it from there instead
  1397. * @param SimplePie_Cache|false $cache Cache handler, or false to not load from the cache
  1398. * @return array|true Returns true if the data was loaded from the cache, or an array of HTTP headers and sniffed type
  1399. */
  1400. protected function fetch_data(&$cache)
  1401. {
  1402. // If it's enabled, use the cache
  1403. if ($cache)
  1404. {
  1405. // Load the Cache
  1406. $this->data = $cache->load();
  1407. if ($cache->mtime() + $this->cache_duration > time())
  1408. {
  1409. $this->raw_data = false;
  1410. return true; // If the cache is still valid, just return true
  1411. }
  1412. elseif (!empty($this->data))
  1413. {
  1414. // If the cache is for an outdated build of SimplePie
  1415. if (!isset($this->data['build']) || $this->data['build'] !== SIMPLEPIE_BUILD)
  1416. {
  1417. $cache->unlink();
  1418. $this->data = array();
  1419. }
  1420. // If we've hit a collision just rerun it with caching disabled
  1421. elseif (isset($this->data['url']) && $this->data['url'] !== $this->feed_url)
  1422. {
  1423. $cache = false;
  1424. $this->data = array();
  1425. }
  1426. // If we've got a non feed_url stored (if the page isn't actually a feed, or is a redirect) use that URL.
  1427. elseif (isset($this->data['feed_url']))
  1428. {
  1429. // If the autodiscovery cache is still valid use it.
  1430. if ($cache->mtime() + $this->autodiscovery_cache_duration > time())
  1431. {
  1432. // Do not need to do feed autodiscovery yet.
  1433. if ($this->data['feed_url'] !== $this->data['url'])
  1434. {
  1435. $this->set_feed_url($this->data['feed_url']);
  1436. return $this->init();
  1437. }
  1438. $cache->unlink();
  1439. $this->data = array();
  1440. }
  1441. }
  1442. // Check if the cache has been updated
  1443. else
  1444. {
  1445. $headers = array(
  1446. 'Accept' => 'application/atom+xml, application/rss+xml, application/rdf+xml;q=0.9, application/xml;q=0.8, text/xml;q=0.8, text/html;q=0.7, unknown/unknown;q=0.1, application/unknown;q=0.1, */*;q=0.1',
  1447. );
  1448. if (isset($this->data['headers']['last-modified']))
  1449. {
  1450. $headers['if-modified-since'] = $this->data['headers']['last-modified'];
  1451. }
  1452. if (isset($this->data['headers']['etag']))
  1453. {
  1454. $headers['if-none-match'] = $this->data['headers']['etag'];
  1455. }
  1456. $file = $this->registry->create('File', array($this->feed_url, $this->timeout, 5, $headers, $this->useragent, $this->force_fsockopen, $this->curl_options, $this->syslog_enabled));
  1457. if ($file->success)
  1458. {
  1459. if ($file->status_code === 304)
  1460. {
  1461. $cache->touch();
  1462. return true;
  1463. }
  1464. }
  1465. else
  1466. {
  1467. $this->check_modified = false;
  1468. $cache->touch();
  1469. $this->error = $file->error;
  1470. return !empty($this->data);
  1471. }
  1472. $md5 = $this->cleanMd5($file->body);
  1473. if ($this->data['md5'] === $md5) {
  1474. if ($this->syslog_enabled)
  1475. {
  1476. syslog(LOG_DEBUG, 'SimplePie MD5 cache match for ' . SimplePie_Misc::url_remove_credentials($this->feed_url));
  1477. }
  1478. $cache->touch();
  1479. return true; //Content unchanged even though server did not send a 304
  1480. } else {
  1481. if ($this->syslog_enabled)
  1482. {
  1483. syslog(LOG_DEBUG, 'SimplePie MD5 cache no match for ' . SimplePie_Misc::url_remove_credentials($this->feed_url));
  1484. }
  1485. $this->data['md5'] = $md5;
  1486. }
  1487. }
  1488. }
  1489. // If the cache is empty
  1490. else
  1491. {
  1492. $cache->touch(); //To keep the date/time of the last tentative update
  1493. $this->data = array();
  1494. }
  1495. }
  1496. // If we don't already have the file (it'll only exist if we've opened it to check if the cache has been modified), open it.
  1497. if (!isset($file))
  1498. {
  1499. if ($this->file instanceof SimplePie_File && $this->file->url === $this->feed_url)
  1500. {
  1501. $file =& $this->file;
  1502. }
  1503. else
  1504. {
  1505. $headers = array(
  1506. 'Accept' => 'application/atom+xml, application/rss+xml, application/rdf+xml;q=0.9, application/xml;q=0.8, text/xml;q=0.8, text/html;q=0.7, unknown/unknown;q=0.1, application/unknown;q=0.1, */*;q=0.1',
  1507. );
  1508. $file = $this->registry->create('File', array($this->feed_url, $this->timeout, 5, $headers, $this->useragent, $this->force_fsockopen, $this->curl_options, $this->syslog_enabled));
  1509. }
  1510. }
  1511. // If the file connection has an error, set SimplePie::error to that and quit
  1512. if (!$file->success && !($file->method & SIMPLEPIE_FILE_SOURCE_REMOTE === 0 || ($file->status_code === 200 || $file->status_code > 206 && $file->status_code < 300)))
  1513. {
  1514. $this->error = $file->error;
  1515. return !empty($this->data);
  1516. }
  1517. if (!$this->force_feed)
  1518. {
  1519. // Check if the supplied URL is a feed, if it isn't, look for it.
  1520. $locate = $this->registry->create('Locator', array(&$file, $this->timeout, $this->useragent, $this->max_checked_feeds, $this->force_fsockopen, $this->curl_options));
  1521. if (!$locate->is_feed($file))
  1522. {
  1523. $copyStatusCode = $file->status_code;
  1524. $copyContentType = $file->headers['content-type'];
  1525. try
  1526. {
  1527. $microformats = false;
  1528. if (class_exists('DOMXpath') && function_exists('Mf2\parse')) {
  1529. $doc = new DOMDocument();
  1530. @$doc->loadHTML($file->body);
  1531. $xpath = new DOMXpath($doc);
  1532. // Check for both h-feed and h-entry, as both a feed with no entries
  1533. // and a list of entries without an h-feed wrapper are both valid.
  1534. $query = '//*[contains(concat(" ", @class, " "), " h-feed ") or '.
  1535. 'contains(concat(" ", @class, " "), " h-entry ")]';
  1536. $result = $xpath->query($query);
  1537. $microformats = $result->length !== 0;
  1538. }
  1539. // Now also do feed discovery, but if microformats were found don't
  1540. // overwrite the current value of file.
  1541. $discovered = $locate->find($this->autodiscovery,
  1542. $this->all_discovered_feeds);
  1543. if ($microformats)
  1544. {
  1545. if ($hub = $locate->get_rel_link('hub'))
  1546. {
  1547. $self = $locate->get_rel_link('self');
  1548. $this->store_links($file, $hub, $self);
  1549. }
  1550. // Push the current file onto all_discovered feeds so the user can
  1551. // be shown this as one of the options.
  1552. if (isset($this->all_discovered_feeds)) {
  1553. $this->all_discovered_feeds[] = $file;
  1554. }
  1555. }
  1556. else
  1557. {
  1558. if ($discovered)
  1559. {
  1560. $file = $discovered;
  1561. }
  1562. else
  1563. {
  1564. // We need to unset this so that if SimplePie::set_file() has
  1565. // been called that object is untouched
  1566. unset($file);
  1567. $this->error = "A feed could not be found at `$this->feed_url`; the status code is `$copyStatusCode` and content-type is `$copyContentType`";
  1568. $this->registry->call('Misc', 'error', array($this->error, E_USER_NOTICE, __FILE__, __LINE__));
  1569. return false;
  1570. }
  1571. }
  1572. }
  1573. catch (SimplePie_Exception $e)
  1574. {
  1575. // We need to unset this so that if SimplePie::set_file() has been called that object is untouched
  1576. unset($file);
  1577. // This is usually because DOMDocument doesn't exist
  1578. $this->error = $e->getMessage();
  1579. $this->registry->call('Misc', 'error', array($this->error, E_USER_NOTICE, $e->getFile(), $e->getLine()));
  1580. return false;
  1581. }
  1582. if ($cache)
  1583. {
  1584. $this->data = array('url' => $this->feed_url, 'feed_url' => $file->url, 'build' => SIMPLEPIE_BUILD);
  1585. $this->data['mtime'] = time();
  1586. $this->data['md5'] = empty($md5) ? $this->cleanMd5($file->body) : $md5;
  1587. if (!$cache->save($this))
  1588. {
  1589. trigger_error("$this->cache_location is not writable. Make sure you've set the correct relative or absolute path, and that the location is server-writable.", E_USER_WARNING);
  1590. }
  1591. $cache = $this->registry->call('Cache', 'get_handler', array($this->cache_location, call_user_func($this->cache_name_function, $file->url), 'spc'));
  1592. }
  1593. }
  1594. $this->feed_url = $file->url;
  1595. $locate = null;
  1596. }
  1597. $file->body = trim($file->body); //FreshRSS
  1598. $this->raw_data = $file->body;
  1599. $this->permanent_url = $file->permanent_url;
  1600. $headers = $file->headers;
  1601. $sniffer = $this->registry->create('Content_Type_Sniffer', array(&$file));
  1602. $sniffed = $sniffer->get_type();
  1603. return array($headers, $sniffed);
  1604. }
  1605. /**
  1606. * Get the error message for the occured error
  1607. *
  1608. * @return string|array Error message, or array of messages for multifeeds
  1609. */
  1610. public function error()
  1611. {
  1612. return $this->error;
  1613. }
  1614. /**
  1615. * Get the raw XML
  1616. *
  1617. * This is the same as the old `$feed->enable_xml_dump(true)`, but returns
  1618. * the data instead of printing it.
  1619. *
  1620. * @return string|boolean Raw XML data, false if the cache is used
  1621. */
  1622. public function get_raw_data()
  1623. {
  1624. return $this->raw_data;
  1625. }
  1626. /**
  1627. * Get the character encoding used for output
  1628. *
  1629. * @since Preview Release
  1630. * @return string
  1631. */
  1632. public function get_encoding()
  1633. {
  1634. return $this->sanitize->output_encoding;
  1635. }
  1636. /**
  1637. * Send the content-type header with correct encoding
  1638. *
  1639. * This method ensures that the SimplePie-enabled page is being served with
  1640. * the correct {@link http://www.iana.org/assignments/media-types/ mime-type}
  1641. * and character encoding HTTP headers (character encoding determined by the
  1642. * {@see set_output_encoding} config option).
  1643. *
  1644. * This won't work properly if any content or whitespace has already been
  1645. * sent to the browser, because it relies on PHP's
  1646. * {@link http://php.net/header header()} function, and these are the
  1647. * circumstances under which the function works.
  1648. *
  1649. * Because it's setting these settings for the entire page (as is the nature
  1650. * of HTTP headers), this should only be used once per page (again, at the
  1651. * top).
  1652. *
  1653. * @param string $mime MIME type to serve the page as
  1654. */
  1655. public function handle_content_type($mime = 'text/html')
  1656. {
  1657. if (!headers_sent())
  1658. {
  1659. $header = "Content-type: $mime;";
  1660. if ($this->get_encoding())
  1661. {
  1662. $header .= ' charset=' . $this->get_encoding();
  1663. }
  1664. else
  1665. {
  1666. $header .= ' charset=UTF-8';
  1667. }
  1668. header($header);
  1669. }
  1670. }
  1671. /**
  1672. * Get the type of the feed
  1673. *
  1674. * This returns a SIMPLEPIE_TYPE_* constant, which can be tested against
  1675. * using {@link http://php.net/language.operators.bitwise bitwise operators}
  1676. *
  1677. * @since 0.8 (usage changed to using constants in 1.0)
  1678. * @see SIMPLEPIE_TYPE_NONE Unknown.
  1679. * @see SIMPLEPIE_TYPE_RSS_090 RSS 0.90.
  1680. * @see SIMPLEPIE_TYPE_RSS_091_NETSCAPE RSS 0.91 (Netscape).
  1681. * @see SIMPLEPIE_TYPE_RSS_091_USERLAND RSS 0.91 (Userland).
  1682. * @see SIMPLEPIE_TYPE_RSS_091 RSS 0.91.
  1683. * @see SIMPLEPIE_TYPE_RSS_092 RSS 0.92.
  1684. * @see SIMPLEPIE_TYPE_RSS_093 RSS 0.93.
  1685. * @see SIMPLEPIE_TYPE_RSS_094 RSS 0.94.
  1686. * @see SIMPLEPIE_TYPE_RSS_10 RSS 1.0.
  1687. * @see SIMPLEPIE_TYPE_RSS_20 RSS 2.0.x.
  1688. * @see SIMPLEPIE_TYPE_RSS_RDF RDF-based RSS.
  1689. * @see SIMPLEPIE_TYPE_RSS_SYNDICATION Non-RDF-based RSS (truly intended as syndication format).
  1690. * @see SIMPLEPIE_TYPE_RSS_ALL Any version of RSS.
  1691. * @see SIMPLEPIE_TYPE_ATOM_03 Atom 0.3.
  1692. * @see SIMPLEPIE_TYPE_ATOM_10 Atom 1.0.
  1693. * @see SIMPLEPIE_TYPE_ATOM_ALL Any version of Atom.
  1694. * @see SIMPLEPIE_TYPE_ALL Any known/supported feed type.
  1695. * @return int SIMPLEPIE_TYPE_* constant
  1696. */
  1697. public function get_type()
  1698. {
  1699. if (!isset($this->data['type']))
  1700. {
  1701. $this->data['type'] = SIMPLEPIE_TYPE_ALL;
  1702. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['feed']))
  1703. {
  1704. $this->data['type'] &= SIMPLEPIE_TYPE_ATOM_10;
  1705. }
  1706. elseif (isset($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['feed']))
  1707. {
  1708. $this->data['type'] &= SIMPLEPIE_TYPE_ATOM_03;
  1709. }
  1710. elseif (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF']))
  1711. {
  1712. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_10]['channel'])
  1713. || isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_10]['image'])
  1714. || isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_10]['item'])
  1715. || isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_10]['textinput']))
  1716. {
  1717. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_10;
  1718. }
  1719. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_090]['channel'])
  1720. || isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_090]['image'])
  1721. || isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_090]['item'])
  1722. || isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_090]['textinput']))
  1723. {
  1724. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_090;
  1725. }
  1726. }
  1727. elseif (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RSS_20]['rss']))
  1728. {
  1729. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_ALL;
  1730. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RSS_20]['rss'][0]['attribs']['']['version']))
  1731. {
  1732. switch (trim($this->data['child'][SIMPLEPIE_NAMESPACE_RSS_20]['rss'][0]['attribs']['']['version']))
  1733. {
  1734. case '0.91':
  1735. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_091;
  1736. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RSS_20]['rss'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_20]['skiphours']['hour'][0]['data']))
  1737. {
  1738. switch (trim($this->data['child'][SIMPLEPIE_NAMESPACE_RSS_20]['rss'][0]['child'][SIMPLEPIE_NAMESPACE_RSS_20]['skiphours']['hour'][0]['data']))
  1739. {
  1740. case '0':
  1741. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_091_NETSCAPE;
  1742. break;
  1743. case '24':
  1744. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_091_USERLAND;
  1745. break;
  1746. }
  1747. }
  1748. break;
  1749. case '0.92':
  1750. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_092;
  1751. break;
  1752. case '0.93':
  1753. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_093;
  1754. break;
  1755. case '0.94':
  1756. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_094;
  1757. break;
  1758. case '2.0':
  1759. $this->data['type'] &= SIMPLEPIE_TYPE_RSS_20;
  1760. break;
  1761. }
  1762. }
  1763. }
  1764. else
  1765. {
  1766. $this->data['type'] = SIMPLEPIE_TYPE_NONE;
  1767. }
  1768. }
  1769. return $this->data['type'];
  1770. }
  1771. /**
  1772. * Get the URL for the feed
  1773. *
  1774. * When the 'permanent' mode is enabled, returns the original feed URL,
  1775. * except in the case of an `HTTP 301 Moved Permanently` status response,
  1776. * in which case the location of the first redirection is returned.
  1777. *
  1778. * When the 'permanent' mode is disabled (default),
  1779. * may or may not be different from the URL passed to {@see set_feed_url()},
  1780. * depending on whether auto-discovery was used, and whether there were
  1781. * any redirects along the way.
  1782. *
  1783. * @since Preview Release (previously called `get_feed_url()` since SimplePie 0.8.)
  1784. * @todo Support <itunes:new-feed-url>
  1785. * @todo Also, |atom:link|@rel=self
  1786. * @param bool $permanent Permanent mode to return only the original URL or the first redirection
  1787. * iff it is a 301 redirection
  1788. * @return string|null
  1789. */
  1790. public function subscribe_url($permanent = false)
  1791. {
  1792. if ($permanent)
  1793. {
  1794. if ($this->permanent_url !== null)
  1795. {
  1796. // sanitize encodes ampersands which are required when used in a url.
  1797. return str_replace('&amp;', '&',
  1798. $this->sanitize($this->permanent_url,
  1799. SIMPLEPIE_CONSTRUCT_IRI));
  1800. }
  1801. }
  1802. else
  1803. {
  1804. if ($this->feed_url !== null)
  1805. {
  1806. return str_replace('&amp;', '&',
  1807. $this->sanitize($this->feed_url,
  1808. SIMPLEPIE_CONSTRUCT_IRI));
  1809. }
  1810. }
  1811. return null;
  1812. }
  1813. /**
  1814. * Get data for an feed-level element
  1815. *
  1816. * This method allows you to get access to ANY element/attribute that is a
  1817. * sub-element of the opening feed tag.
  1818. *
  1819. * The return value is an indexed array of elements matching the given
  1820. * namespace and tag name. Each element has `attribs`, `data` and `child`
  1821. * subkeys. For `attribs` and `child`, these contain namespace subkeys.
  1822. * `attribs` then has one level of associative name => value data (where
  1823. * `value` is a string) after the namespace. `child` has tag-indexed keys
  1824. * after the namespace, each member of which is an indexed array matching
  1825. * this same format.
  1826. *
  1827. * For example:
  1828. * <pre>
  1829. * // This is probably a bad example because we already support
  1830. * // <media:content> natively, but it shows you how to parse through
  1831. * // the nodes.
  1832. * $group = $item->get_item_tags(SIMPLEPIE_NAMESPACE_MEDIARSS, 'group');
  1833. * $content = $group[0]['child'][SIMPLEPIE_NAMESPACE_MEDIARSS]['content'];
  1834. * $file = $content[0]['attribs']['']['url'];
  1835. * echo $file;
  1836. * </pre>
  1837. *
  1838. * @since 1.0
  1839. * @see http://simplepie.org/wiki/faq/supported_xml_namespaces
  1840. * @param string $namespace The URL of the XML namespace of the elements you're trying to access
  1841. * @param string $tag Tag name
  1842. * @return array
  1843. */
  1844. public function get_feed_tags($namespace, $tag)
  1845. {
  1846. $type = $this->get_type();
  1847. if ($type & SIMPLEPIE_TYPE_ATOM_10)
  1848. {
  1849. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['feed'][0]['child'][$namespace][$tag]))
  1850. {
  1851. return $this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['feed'][0]['child'][$namespace][$tag];
  1852. }
  1853. }
  1854. if ($type & SIMPLEPIE_TYPE_ATOM_03)
  1855. {
  1856. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['feed'][0]['child'][$namespace][$tag]))
  1857. {
  1858. return $this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['feed'][0]['child'][$namespace][$tag];
  1859. }
  1860. }
  1861. if ($type & SIMPLEPIE_TYPE_RSS_RDF)
  1862. {
  1863. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][$namespace][$tag]))
  1864. {
  1865. return $this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['child'][$namespace][$tag];
  1866. }
  1867. }
  1868. if ($type & SIMPLEPIE_TYPE_RSS_SYNDICATION)
  1869. {
  1870. if (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RSS_20]['rss'][0]['child'][$namespace][$tag]))
  1871. {
  1872. return $this->data['child'][SIMPLEPIE_NAMESPACE_RSS_20]['rss'][0]['child'][$namespace][$tag];
  1873. }
  1874. }
  1875. return null;
  1876. }
  1877. /**
  1878. * Get data for an channel-level element
  1879. *
  1880. * This method allows you to get access to ANY element/attribute in the
  1881. * channel/header section of the feed.
  1882. *
  1883. * See {@see SimplePie::get_feed_tags()} for a description of the return value
  1884. *
  1885. * @since 1.0
  1886. * @see http://simplepie.org/wiki/faq/supported_xml_namespaces
  1887. * @param string $namespace The URL of the XML namespace of the elements you're trying to access
  1888. * @param string $tag Tag name
  1889. * @return array
  1890. */
  1891. public function get_channel_tags($namespace, $tag)
  1892. {
  1893. $type = $this->get_type();
  1894. if ($type & SIMPLEPIE_TYPE_ATOM_ALL)
  1895. {
  1896. if ($return = $this->get_feed_tags($namespace, $tag))
  1897. {
  1898. return $return;
  1899. }
  1900. }
  1901. if ($type & SIMPLEPIE_TYPE_RSS_10)
  1902. {
  1903. if ($channel = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'channel'))
  1904. {
  1905. if (isset($channel[0]['child'][$namespace][$tag]))
  1906. {
  1907. return $channel[0]['child'][$namespace][$tag];
  1908. }
  1909. }
  1910. }
  1911. if ($type & SIMPLEPIE_TYPE_RSS_090)
  1912. {
  1913. if ($channel = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'channel'))
  1914. {
  1915. if (isset($channel[0]['child'][$namespace][$tag]))
  1916. {
  1917. return $channel[0]['child'][$namespace][$tag];
  1918. }
  1919. }
  1920. }
  1921. if ($type & SIMPLEPIE_TYPE_RSS_SYNDICATION)
  1922. {
  1923. if ($channel = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'channel'))
  1924. {
  1925. if (isset($channel[0]['child'][$namespace][$tag]))
  1926. {
  1927. return $channel[0]['child'][$namespace][$tag];
  1928. }
  1929. }
  1930. }
  1931. return null;
  1932. }
  1933. /**
  1934. * Get data for an channel-level element
  1935. *
  1936. * This method allows you to get access to ANY element/attribute in the
  1937. * image/logo section of the feed.
  1938. *
  1939. * See {@see SimplePie::get_feed_tags()} for a description of the return value
  1940. *
  1941. * @since 1.0
  1942. * @see http://simplepie.org/wiki/faq/supported_xml_namespaces
  1943. * @param string $namespace The URL of the XML namespace of the elements you're trying to access
  1944. * @param string $tag Tag name
  1945. * @return array
  1946. */
  1947. public function get_image_tags($namespace, $tag)
  1948. {
  1949. $type = $this->get_type();
  1950. if ($type & SIMPLEPIE_TYPE_RSS_10)
  1951. {
  1952. if ($image = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'image'))
  1953. {
  1954. if (isset($image[0]['child'][$namespace][$tag]))
  1955. {
  1956. return $image[0]['child'][$namespace][$tag];
  1957. }
  1958. }
  1959. }
  1960. if ($type & SIMPLEPIE_TYPE_RSS_090)
  1961. {
  1962. if ($image = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'image'))
  1963. {
  1964. if (isset($image[0]['child'][$namespace][$tag]))
  1965. {
  1966. return $image[0]['child'][$namespace][$tag];
  1967. }
  1968. }
  1969. }
  1970. if ($type & SIMPLEPIE_TYPE_RSS_SYNDICATION)
  1971. {
  1972. if ($image = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'image'))
  1973. {
  1974. if (isset($image[0]['child'][$namespace][$tag]))
  1975. {
  1976. return $image[0]['child'][$namespace][$tag];
  1977. }
  1978. }
  1979. }
  1980. return null;
  1981. }
  1982. /**
  1983. * Get the base URL value from the feed
  1984. *
  1985. * Uses `<xml:base>` if available, otherwise uses the first link in the
  1986. * feed, or failing that, the URL of the feed itself.
  1987. *
  1988. * @see get_link
  1989. * @see subscribe_url
  1990. *
  1991. * @param array $element
  1992. * @return string
  1993. */
  1994. public function get_base($element = array())
  1995. {
  1996. if (!($this->get_type() & SIMPLEPIE_TYPE_RSS_SYNDICATION) && !empty($element['xml_base_explicit']) && isset($element['xml_base']))
  1997. {
  1998. return $element['xml_base'];
  1999. }
  2000. elseif ($this->get_link() !== null)
  2001. {
  2002. return $this->get_link();
  2003. }
  2004. return $this->subscribe_url();
  2005. }
  2006. /**
  2007. * Sanitize feed data
  2008. *
  2009. * @access private
  2010. * @see SimplePie_Sanitize::sanitize()
  2011. * @param string $data Data to sanitize
  2012. * @param int $type One of the SIMPLEPIE_CONSTRUCT_* constants
  2013. * @param string $base Base URL to resolve URLs against
  2014. * @return string Sanitized data
  2015. */
  2016. public function sanitize($data, $type, $base = '')
  2017. {
  2018. try
  2019. {
  2020. return $this->sanitize->sanitize($data, $type, $base);
  2021. }
  2022. catch (SimplePie_Exception $e)
  2023. {
  2024. if (!$this->enable_exceptions)
  2025. {
  2026. $this->error = $e->getMessage();
  2027. $this->registry->call('Misc', 'error', array($this->error, E_USER_WARNING, $e->getFile(), $e->getLine()));
  2028. return '';
  2029. }
  2030. throw $e;
  2031. }
  2032. }
  2033. /**
  2034. * Get the title of the feed
  2035. *
  2036. * Uses `<atom:title>`, `<title>` or `<dc:title>`
  2037. *
  2038. * @since 1.0 (previously called `get_feed_title` since 0.8)
  2039. * @return string|null
  2040. */
  2041. public function get_title()
  2042. {
  2043. if ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'title'))
  2044. {
  2045. return $this->sanitize($return[0]['data'], $this->registry->call('Misc', 'atom_10_construct_type', array($return[0]['attribs'])), $this->get_base($return[0]));
  2046. }
  2047. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_03, 'title'))
  2048. {
  2049. return $this->sanitize($return[0]['data'], $this->registry->call('Misc', 'atom_03_construct_type', array($return[0]['attribs'])), $this->get_base($return[0]));
  2050. }
  2051. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'title'))
  2052. {
  2053. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
  2054. }
  2055. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'title'))
  2056. {
  2057. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
  2058. }
  2059. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'title'))
  2060. {
  2061. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
  2062. }
  2063. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_11, 'title'))
  2064. {
  2065. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2066. }
  2067. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_10, 'title'))
  2068. {
  2069. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2070. }
  2071. return null;
  2072. }
  2073. /**
  2074. * Get a category for the feed
  2075. *
  2076. * @since Unknown
  2077. * @param int $key The category that you want to return. Remember that arrays begin with 0, not 1
  2078. * @return SimplePie_Category|null
  2079. */
  2080. public function get_category($key = 0)
  2081. {
  2082. $categories = $this->get_categories();
  2083. if (isset($categories[$key]))
  2084. {
  2085. return $categories[$key];
  2086. }
  2087. return null;
  2088. }
  2089. /**
  2090. * Get all categories for the feed
  2091. *
  2092. * Uses `<atom:category>`, `<category>` or `<dc:subject>`
  2093. *
  2094. * @since Unknown
  2095. * @return array|null List of {@see SimplePie_Category} objects
  2096. */
  2097. public function get_categories()
  2098. {
  2099. $categories = array();
  2100. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'category') as $category)
  2101. {
  2102. $term = null;
  2103. $scheme = null;
  2104. $label = null;
  2105. if (isset($category['attribs']['']['term']))
  2106. {
  2107. $term = $this->sanitize($category['attribs']['']['term'], SIMPLEPIE_CONSTRUCT_TEXT);
  2108. }
  2109. if (isset($category['attribs']['']['scheme']))
  2110. {
  2111. $scheme = $this->sanitize($category['attribs']['']['scheme'], SIMPLEPIE_CONSTRUCT_TEXT);
  2112. }
  2113. if (isset($category['attribs']['']['label']))
  2114. {
  2115. $label = $this->sanitize($category['attribs']['']['label'], SIMPLEPIE_CONSTRUCT_TEXT);
  2116. }
  2117. $categories[] = $this->registry->create('Category', array($term, $scheme, $label));
  2118. }
  2119. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'category') as $category)
  2120. {
  2121. // This is really the label, but keep this as the term also for BC.
  2122. // Label will also work on retrieving because that falls back to term.
  2123. $term = $this->sanitize($category['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2124. if (isset($category['attribs']['']['domain']))
  2125. {
  2126. $scheme = $this->sanitize($category['attribs']['']['domain'], SIMPLEPIE_CONSTRUCT_TEXT);
  2127. }
  2128. else
  2129. {
  2130. $scheme = null;
  2131. }
  2132. $categories[] = $this->registry->create('Category', array($term, $scheme, null));
  2133. }
  2134. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_11, 'subject') as $category)
  2135. {
  2136. $categories[] = $this->registry->create('Category', array($this->sanitize($category['data'], SIMPLEPIE_CONSTRUCT_TEXT), null, null));
  2137. }
  2138. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_10, 'subject') as $category)
  2139. {
  2140. $categories[] = $this->registry->create('Category', array($this->sanitize($category['data'], SIMPLEPIE_CONSTRUCT_TEXT), null, null));
  2141. }
  2142. if (!empty($categories))
  2143. {
  2144. return array_unique($categories);
  2145. }
  2146. return null;
  2147. }
  2148. /**
  2149. * Get an author for the feed
  2150. *
  2151. * @since 1.1
  2152. * @param int $key The author that you want to return. Remember that arrays begin with 0, not 1
  2153. * @return SimplePie_Author|null
  2154. */
  2155. public function get_author($key = 0)
  2156. {
  2157. $authors = $this->get_authors();
  2158. if (isset($authors[$key]))
  2159. {
  2160. return $authors[$key];
  2161. }
  2162. return null;
  2163. }
  2164. /**
  2165. * Get all authors for the feed
  2166. *
  2167. * Uses `<atom:author>`, `<author>`, `<dc:creator>` or `<itunes:author>`
  2168. *
  2169. * @since 1.1
  2170. * @return array|null List of {@see SimplePie_Author} objects
  2171. */
  2172. public function get_authors()
  2173. {
  2174. $authors = array();
  2175. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'author') as $author)
  2176. {
  2177. $name = null;
  2178. $uri = null;
  2179. $email = null;
  2180. if (isset($author['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['name'][0]['data']))
  2181. {
  2182. $name = $this->sanitize($author['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['name'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2183. }
  2184. if (isset($author['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['uri'][0]['data']))
  2185. {
  2186. $uri = $this->sanitize($author['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['uri'][0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($author['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['uri'][0]));
  2187. }
  2188. if (isset($author['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['email'][0]['data']))
  2189. {
  2190. $email = $this->sanitize($author['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['email'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2191. }
  2192. if ($name !== null || $email !== null || $uri !== null)
  2193. {
  2194. $authors[] = $this->registry->create('Author', array($name, $uri, $email));
  2195. }
  2196. }
  2197. if ($author = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_03, 'author'))
  2198. {
  2199. $name = null;
  2200. $url = null;
  2201. $email = null;
  2202. if (isset($author[0]['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['name'][0]['data']))
  2203. {
  2204. $name = $this->sanitize($author[0]['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['name'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2205. }
  2206. if (isset($author[0]['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['url'][0]['data']))
  2207. {
  2208. $url = $this->sanitize($author[0]['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['url'][0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($author[0]['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['url'][0]));
  2209. }
  2210. if (isset($author[0]['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['email'][0]['data']))
  2211. {
  2212. $email = $this->sanitize($author[0]['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['email'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2213. }
  2214. if ($name !== null || $email !== null || $url !== null)
  2215. {
  2216. $authors[] = $this->registry->create('Author', array($name, $url, $email));
  2217. }
  2218. }
  2219. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_11, 'creator') as $author)
  2220. {
  2221. $authors[] = $this->registry->create('Author', array($this->sanitize($author['data'], SIMPLEPIE_CONSTRUCT_TEXT), null, null));
  2222. }
  2223. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_10, 'creator') as $author)
  2224. {
  2225. $authors[] = $this->registry->create('Author', array($this->sanitize($author['data'], SIMPLEPIE_CONSTRUCT_TEXT), null, null));
  2226. }
  2227. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ITUNES, 'author') as $author)
  2228. {
  2229. $authors[] = $this->registry->create('Author', array($this->sanitize($author['data'], SIMPLEPIE_CONSTRUCT_TEXT), null, null));
  2230. }
  2231. if (!empty($authors))
  2232. {
  2233. return array_unique($authors);
  2234. }
  2235. return null;
  2236. }
  2237. /**
  2238. * Get a contributor for the feed
  2239. *
  2240. * @since 1.1
  2241. * @param int $key The contrbutor that you want to return. Remember that arrays begin with 0, not 1
  2242. * @return SimplePie_Author|null
  2243. */
  2244. public function get_contributor($key = 0)
  2245. {
  2246. $contributors = $this->get_contributors();
  2247. if (isset($contributors[$key]))
  2248. {
  2249. return $contributors[$key];
  2250. }
  2251. return null;
  2252. }
  2253. /**
  2254. * Get all contributors for the feed
  2255. *
  2256. * Uses `<atom:contributor>`
  2257. *
  2258. * @since 1.1
  2259. * @return array|null List of {@see SimplePie_Author} objects
  2260. */
  2261. public function get_contributors()
  2262. {
  2263. $contributors = array();
  2264. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'contributor') as $contributor)
  2265. {
  2266. $name = null;
  2267. $uri = null;
  2268. $email = null;
  2269. if (isset($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['name'][0]['data']))
  2270. {
  2271. $name = $this->sanitize($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['name'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2272. }
  2273. if (isset($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['uri'][0]['data']))
  2274. {
  2275. $uri = $this->sanitize($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['uri'][0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['uri'][0]));
  2276. }
  2277. if (isset($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['email'][0]['data']))
  2278. {
  2279. $email = $this->sanitize($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['email'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2280. }
  2281. if ($name !== null || $email !== null || $uri !== null)
  2282. {
  2283. $contributors[] = $this->registry->create('Author', array($name, $uri, $email));
  2284. }
  2285. }
  2286. foreach ((array) $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_03, 'contributor') as $contributor)
  2287. {
  2288. $name = null;
  2289. $url = null;
  2290. $email = null;
  2291. if (isset($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['name'][0]['data']))
  2292. {
  2293. $name = $this->sanitize($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['name'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2294. }
  2295. if (isset($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['url'][0]['data']))
  2296. {
  2297. $url = $this->sanitize($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['url'][0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['url'][0]));
  2298. }
  2299. if (isset($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['email'][0]['data']))
  2300. {
  2301. $email = $this->sanitize($contributor['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['email'][0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2302. }
  2303. if ($name !== null || $email !== null || $url !== null)
  2304. {
  2305. $contributors[] = $this->registry->create('Author', array($name, $url, $email));
  2306. }
  2307. }
  2308. if (!empty($contributors))
  2309. {
  2310. return array_unique($contributors);
  2311. }
  2312. return null;
  2313. }
  2314. /**
  2315. * Get a single link for the feed
  2316. *
  2317. * @since 1.0 (previously called `get_feed_link` since Preview Release, `get_feed_permalink()` since 0.8)
  2318. * @param int $key The link that you want to return. Remember that arrays begin with 0, not 1
  2319. * @param string $rel The relationship of the link to return
  2320. * @return string|null Link URL
  2321. */
  2322. public function get_link($key = 0, $rel = 'alternate')
  2323. {
  2324. $links = $this->get_links($rel);
  2325. if (isset($links[$key]))
  2326. {
  2327. return $links[$key];
  2328. }
  2329. return null;
  2330. }
  2331. /**
  2332. * Get the permalink for the item
  2333. *
  2334. * Returns the first link available with a relationship of "alternate".
  2335. * Identical to {@see get_link()} with key 0
  2336. *
  2337. * @see get_link
  2338. * @since 1.0 (previously called `get_feed_link` since Preview Release, `get_feed_permalink()` since 0.8)
  2339. * @internal Added for parity between the parent-level and the item/entry-level.
  2340. * @return string|null Link URL
  2341. */
  2342. public function get_permalink()
  2343. {
  2344. return $this->get_link(0);
  2345. }
  2346. /**
  2347. * Get all links for the feed
  2348. *
  2349. * Uses `<atom:link>` or `<link>`
  2350. *
  2351. * @since Beta 2
  2352. * @param string $rel The relationship of links to return
  2353. * @return array|null Links found for the feed (strings)
  2354. */
  2355. public function get_links($rel = 'alternate')
  2356. {
  2357. if (!isset($this->data['links']))
  2358. {
  2359. $this->data['links'] = array();
  2360. if ($links = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'link'))
  2361. {
  2362. foreach ($links as $link)
  2363. {
  2364. if (isset($link['attribs']['']['href']))
  2365. {
  2366. $link_rel = (isset($link['attribs']['']['rel'])) ? $link['attribs']['']['rel'] : 'alternate';
  2367. $this->data['links'][$link_rel][] = $this->sanitize($link['attribs']['']['href'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($link));
  2368. }
  2369. }
  2370. }
  2371. if ($links = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_03, 'link'))
  2372. {
  2373. foreach ($links as $link)
  2374. {
  2375. if (isset($link['attribs']['']['href']))
  2376. {
  2377. $link_rel = (isset($link['attribs']['']['rel'])) ? $link['attribs']['']['rel'] : 'alternate';
  2378. $this->data['links'][$link_rel][] = $this->sanitize($link['attribs']['']['href'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($link));
  2379. }
  2380. }
  2381. }
  2382. if ($links = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'link'))
  2383. {
  2384. $this->data['links']['alternate'][] = $this->sanitize($links[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($links[0]));
  2385. }
  2386. if ($links = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'link'))
  2387. {
  2388. $this->data['links']['alternate'][] = $this->sanitize($links[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($links[0]));
  2389. }
  2390. if ($links = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'link'))
  2391. {
  2392. $this->data['links']['alternate'][] = $this->sanitize($links[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($links[0]));
  2393. }
  2394. $keys = array_keys($this->data['links']);
  2395. foreach ($keys as $key)
  2396. {
  2397. if ($this->registry->call('Misc', 'is_isegment_nz_nc', array($key)))
  2398. {
  2399. if (isset($this->data['links'][SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY . $key]))
  2400. {
  2401. $this->data['links'][SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY . $key] = array_merge($this->data['links'][$key], $this->data['links'][SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY . $key]);
  2402. $this->data['links'][$key] =& $this->data['links'][SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY . $key];
  2403. }
  2404. else
  2405. {
  2406. $this->data['links'][SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY . $key] =& $this->data['links'][$key];
  2407. }
  2408. }
  2409. elseif (substr($key, 0, 41) === SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY)
  2410. {
  2411. $this->data['links'][substr($key, 41)] =& $this->data['links'][$key];
  2412. }
  2413. $this->data['links'][$key] = array_unique($this->data['links'][$key]);
  2414. }
  2415. }
  2416. if (isset($this->data['headers']['link']) &&
  2417. preg_match('/<([^>]+)>; rel='.preg_quote($rel).'/',
  2418. $this->data['headers']['link'], $match))
  2419. {
  2420. return array($match[1]);
  2421. }
  2422. else if (isset($this->data['links'][$rel]))
  2423. {
  2424. return $this->data['links'][$rel];
  2425. }
  2426. return null;
  2427. }
  2428. public function get_all_discovered_feeds()
  2429. {
  2430. return $this->all_discovered_feeds;
  2431. }
  2432. /**
  2433. * Get the content for the item
  2434. *
  2435. * Uses `<atom:subtitle>`, `<atom:tagline>`, `<description>`,
  2436. * `<dc:description>`, `<itunes:summary>` or `<itunes:subtitle>`
  2437. *
  2438. * @since 1.0 (previously called `get_feed_description()` since 0.8)
  2439. * @return string|null
  2440. */
  2441. public function get_description()
  2442. {
  2443. if ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'subtitle'))
  2444. {
  2445. return $this->sanitize($return[0]['data'], $this->registry->call('Misc', 'atom_10_construct_type', array($return[0]['attribs'])), $this->get_base($return[0]));
  2446. }
  2447. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_03, 'tagline'))
  2448. {
  2449. return $this->sanitize($return[0]['data'], $this->registry->call('Misc', 'atom_03_construct_type', array($return[0]['attribs'])), $this->get_base($return[0]));
  2450. }
  2451. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'description'))
  2452. {
  2453. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
  2454. }
  2455. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'description'))
  2456. {
  2457. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_MAYBE_HTML, $this->get_base($return[0]));
  2458. }
  2459. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'description'))
  2460. {
  2461. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_HTML, $this->get_base($return[0]));
  2462. }
  2463. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_11, 'description'))
  2464. {
  2465. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2466. }
  2467. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_10, 'description'))
  2468. {
  2469. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2470. }
  2471. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ITUNES, 'summary'))
  2472. {
  2473. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_HTML, $this->get_base($return[0]));
  2474. }
  2475. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ITUNES, 'subtitle'))
  2476. {
  2477. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_HTML, $this->get_base($return[0]));
  2478. }
  2479. return null;
  2480. }
  2481. /**
  2482. * Get the copyright info for the feed
  2483. *
  2484. * Uses `<atom:rights>`, `<atom:copyright>` or `<dc:rights>`
  2485. *
  2486. * @since 1.0 (previously called `get_feed_copyright()` since 0.8)
  2487. * @return string|null
  2488. */
  2489. public function get_copyright()
  2490. {
  2491. if ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'rights'))
  2492. {
  2493. return $this->sanitize($return[0]['data'], $this->registry->call('Misc', 'atom_10_construct_type', array($return[0]['attribs'])), $this->get_base($return[0]));
  2494. }
  2495. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_03, 'copyright'))
  2496. {
  2497. return $this->sanitize($return[0]['data'], $this->registry->call('Misc', 'atom_03_construct_type', array($return[0]['attribs'])), $this->get_base($return[0]));
  2498. }
  2499. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'copyright'))
  2500. {
  2501. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2502. }
  2503. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_11, 'rights'))
  2504. {
  2505. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2506. }
  2507. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_10, 'rights'))
  2508. {
  2509. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2510. }
  2511. return null;
  2512. }
  2513. /**
  2514. * Get the language for the feed
  2515. *
  2516. * Uses `<language>`, `<dc:language>`, or @xml_lang
  2517. *
  2518. * @since 1.0 (previously called `get_feed_language()` since 0.8)
  2519. * @return string|null
  2520. */
  2521. public function get_language()
  2522. {
  2523. if ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'language'))
  2524. {
  2525. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2526. }
  2527. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_11, 'language'))
  2528. {
  2529. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2530. }
  2531. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_DC_10, 'language'))
  2532. {
  2533. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2534. }
  2535. elseif (isset($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['feed'][0]['xml_lang']))
  2536. {
  2537. return $this->sanitize($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_10]['feed'][0]['xml_lang'], SIMPLEPIE_CONSTRUCT_TEXT);
  2538. }
  2539. elseif (isset($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['feed'][0]['xml_lang']))
  2540. {
  2541. return $this->sanitize($this->data['child'][SIMPLEPIE_NAMESPACE_ATOM_03]['feed'][0]['xml_lang'], SIMPLEPIE_CONSTRUCT_TEXT);
  2542. }
  2543. elseif (isset($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['xml_lang']))
  2544. {
  2545. return $this->sanitize($this->data['child'][SIMPLEPIE_NAMESPACE_RDF]['RDF'][0]['xml_lang'], SIMPLEPIE_CONSTRUCT_TEXT);
  2546. }
  2547. elseif (isset($this->data['headers']['content-language']))
  2548. {
  2549. return $this->sanitize($this->data['headers']['content-language'], SIMPLEPIE_CONSTRUCT_TEXT);
  2550. }
  2551. return null;
  2552. }
  2553. /**
  2554. * Get the latitude coordinates for the item
  2555. *
  2556. * Compatible with the W3C WGS84 Basic Geo and GeoRSS specifications
  2557. *
  2558. * Uses `<geo:lat>` or `<georss:point>`
  2559. *
  2560. * @since 1.0
  2561. * @link http://www.w3.org/2003/01/geo/ W3C WGS84 Basic Geo
  2562. * @link http://www.georss.org/ GeoRSS
  2563. * @return string|null
  2564. */
  2565. public function get_latitude()
  2566. {
  2567. if ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_W3C_BASIC_GEO, 'lat'))
  2568. {
  2569. return (float) $return[0]['data'];
  2570. }
  2571. elseif (($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_GEORSS, 'point')) && preg_match('/^((?:-)?[0-9]+(?:\.[0-9]+)) ((?:-)?[0-9]+(?:\.[0-9]+))$/', trim($return[0]['data']), $match))
  2572. {
  2573. return (float) $match[1];
  2574. }
  2575. return null;
  2576. }
  2577. /**
  2578. * Get the longitude coordinates for the feed
  2579. *
  2580. * Compatible with the W3C WGS84 Basic Geo and GeoRSS specifications
  2581. *
  2582. * Uses `<geo:long>`, `<geo:lon>` or `<georss:point>`
  2583. *
  2584. * @since 1.0
  2585. * @link http://www.w3.org/2003/01/geo/ W3C WGS84 Basic Geo
  2586. * @link http://www.georss.org/ GeoRSS
  2587. * @return string|null
  2588. */
  2589. public function get_longitude()
  2590. {
  2591. if ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_W3C_BASIC_GEO, 'long'))
  2592. {
  2593. return (float) $return[0]['data'];
  2594. }
  2595. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_W3C_BASIC_GEO, 'lon'))
  2596. {
  2597. return (float) $return[0]['data'];
  2598. }
  2599. elseif (($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_GEORSS, 'point')) && preg_match('/^((?:-)?[0-9]+(?:\.[0-9]+)) ((?:-)?[0-9]+(?:\.[0-9]+))$/', trim($return[0]['data']), $match))
  2600. {
  2601. return (float) $match[2];
  2602. }
  2603. return null;
  2604. }
  2605. /**
  2606. * Get the feed logo's title
  2607. *
  2608. * RSS 0.9.0, 1.0 and 2.0 feeds are allowed to have a "feed logo" title.
  2609. *
  2610. * Uses `<image><title>` or `<image><dc:title>`
  2611. *
  2612. * @return string|null
  2613. */
  2614. public function get_image_title()
  2615. {
  2616. if ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'title'))
  2617. {
  2618. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2619. }
  2620. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'title'))
  2621. {
  2622. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2623. }
  2624. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'title'))
  2625. {
  2626. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2627. }
  2628. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_DC_11, 'title'))
  2629. {
  2630. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2631. }
  2632. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_DC_10, 'title'))
  2633. {
  2634. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_TEXT);
  2635. }
  2636. return null;
  2637. }
  2638. /**
  2639. * Get the feed logo's URL
  2640. *
  2641. * RSS 0.9.0, 2.0, Atom 1.0, and feeds with iTunes RSS tags are allowed to
  2642. * have a "feed logo" URL. This points directly to the image itself.
  2643. *
  2644. * Uses `<itunes:image>`, `<atom:logo>`, `<atom:icon>`,
  2645. * `<image><title>` or `<image><dc:title>`
  2646. *
  2647. * @return string|null
  2648. */
  2649. public function get_image_url()
  2650. {
  2651. if ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ITUNES, 'image'))
  2652. {
  2653. return $this->sanitize($return[0]['attribs']['']['href'], SIMPLEPIE_CONSTRUCT_IRI);
  2654. }
  2655. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'logo'))
  2656. {
  2657. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2658. }
  2659. elseif ($return = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'icon'))
  2660. {
  2661. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2662. }
  2663. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'url'))
  2664. {
  2665. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2666. }
  2667. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'url'))
  2668. {
  2669. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2670. }
  2671. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'url'))
  2672. {
  2673. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2674. }
  2675. return null;
  2676. }
  2677. /**
  2678. * Get the feed logo's link
  2679. *
  2680. * RSS 0.9.0, 1.0 and 2.0 feeds are allowed to have a "feed logo" link. This
  2681. * points to a human-readable page that the image should link to.
  2682. *
  2683. * Uses `<itunes:image>`, `<atom:logo>`, `<atom:icon>`,
  2684. * `<image><title>` or `<image><dc:title>`
  2685. *
  2686. * @return string|null
  2687. */
  2688. public function get_image_link()
  2689. {
  2690. if ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'link'))
  2691. {
  2692. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2693. }
  2694. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'link'))
  2695. {
  2696. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2697. }
  2698. elseif ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'link'))
  2699. {
  2700. return $this->sanitize($return[0]['data'], SIMPLEPIE_CONSTRUCT_IRI, $this->get_base($return[0]));
  2701. }
  2702. return null;
  2703. }
  2704. /**
  2705. * Get the feed logo's link
  2706. *
  2707. * RSS 2.0 feeds are allowed to have a "feed logo" width.
  2708. *
  2709. * Uses `<image><width>` or defaults to 88.0 if no width is specified and
  2710. * the feed is an RSS 2.0 feed.
  2711. *
  2712. * @return int|float|null
  2713. */
  2714. public function get_image_width()
  2715. {
  2716. if ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'width'))
  2717. {
  2718. return round($return[0]['data']);
  2719. }
  2720. elseif ($this->get_type() & SIMPLEPIE_TYPE_RSS_SYNDICATION && $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'url'))
  2721. {
  2722. return 88.0;
  2723. }
  2724. return null;
  2725. }
  2726. /**
  2727. * Get the feed logo's height
  2728. *
  2729. * RSS 2.0 feeds are allowed to have a "feed logo" height.
  2730. *
  2731. * Uses `<image><height>` or defaults to 31.0 if no height is specified and
  2732. * the feed is an RSS 2.0 feed.
  2733. *
  2734. * @return int|float|null
  2735. */
  2736. public function get_image_height()
  2737. {
  2738. if ($return = $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'height'))
  2739. {
  2740. return round($return[0]['data']);
  2741. }
  2742. elseif ($this->get_type() & SIMPLEPIE_TYPE_RSS_SYNDICATION && $this->get_image_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'url'))
  2743. {
  2744. return 31.0;
  2745. }
  2746. return null;
  2747. }
  2748. /**
  2749. * Get the number of items in the feed
  2750. *
  2751. * This is well-suited for {@link http://php.net/for for()} loops with
  2752. * {@see get_item()}
  2753. *
  2754. * @param int $max Maximum value to return. 0 for no limit
  2755. * @return int Number of items in the feed
  2756. */
  2757. public function get_item_quantity($max = 0)
  2758. {
  2759. $max = (int) $max;
  2760. $qty = count($this->get_items());
  2761. if ($max === 0)
  2762. {
  2763. return $qty;
  2764. }
  2765. return ($qty > $max) ? $max : $qty;
  2766. }
  2767. /**
  2768. * Get a single item from the feed
  2769. *
  2770. * This is better suited for {@link http://php.net/for for()} loops, whereas
  2771. * {@see get_items()} is better suited for
  2772. * {@link http://php.net/foreach foreach()} loops.
  2773. *
  2774. * @see get_item_quantity()
  2775. * @since Beta 2
  2776. * @param int $key The item that you want to return. Remember that arrays begin with 0, not 1
  2777. * @return SimplePie_Item|null
  2778. */
  2779. public function get_item($key = 0)
  2780. {
  2781. $items = $this->get_items();
  2782. if (isset($items[$key]))
  2783. {
  2784. return $items[$key];
  2785. }
  2786. return null;
  2787. }
  2788. /**
  2789. * Get all items from the feed
  2790. *
  2791. * This is better suited for {@link http://php.net/for for()} loops, whereas
  2792. * {@see get_items()} is better suited for
  2793. * {@link http://php.net/foreach foreach()} loops.
  2794. *
  2795. * @see get_item_quantity
  2796. * @since Beta 2
  2797. * @param int $start Index to start at
  2798. * @param int $end Number of items to return. 0 for all items after `$start`
  2799. * @return SimplePie_Item[]|null List of {@see SimplePie_Item} objects
  2800. */
  2801. public function get_items($start = 0, $end = 0)
  2802. {
  2803. if (!isset($this->data['items']))
  2804. {
  2805. if (!empty($this->multifeed_objects))
  2806. {
  2807. $this->data['items'] = SimplePie::merge_items($this->multifeed_objects, $start, $end, $this->item_limit);
  2808. if (empty($this->data['items']))
  2809. {
  2810. return array();
  2811. }
  2812. return $this->data['items'];
  2813. }
  2814. $this->data['items'] = array();
  2815. if ($items = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_ATOM_10, 'entry'))
  2816. {
  2817. $keys = array_keys($items);
  2818. foreach ($keys as $key)
  2819. {
  2820. $this->data['items'][] = $this->registry->create('Item', array($this, $items[$key]));
  2821. }
  2822. }
  2823. if ($items = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_ATOM_03, 'entry'))
  2824. {
  2825. $keys = array_keys($items);
  2826. foreach ($keys as $key)
  2827. {
  2828. $this->data['items'][] = $this->registry->create('Item', array($this, $items[$key]));
  2829. }
  2830. }
  2831. if ($items = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_RSS_10, 'item'))
  2832. {
  2833. $keys = array_keys($items);
  2834. foreach ($keys as $key)
  2835. {
  2836. $this->data['items'][] = $this->registry->create('Item', array($this, $items[$key]));
  2837. }
  2838. }
  2839. if ($items = $this->get_feed_tags(SIMPLEPIE_NAMESPACE_RSS_090, 'item'))
  2840. {
  2841. $keys = array_keys($items);
  2842. foreach ($keys as $key)
  2843. {
  2844. $this->data['items'][] = $this->registry->create('Item', array($this, $items[$key]));
  2845. }
  2846. }
  2847. if ($items = $this->get_channel_tags(SIMPLEPIE_NAMESPACE_RSS_20, 'item'))
  2848. {
  2849. $keys = array_keys($items);
  2850. foreach ($keys as $key)
  2851. {
  2852. $this->data['items'][] = $this->registry->create('Item', array($this, $items[$key]));
  2853. }
  2854. }
  2855. }
  2856. if (empty($this->data['items']))
  2857. {
  2858. return array();
  2859. }
  2860. if ($this->order_by_date)
  2861. {
  2862. if (!isset($this->data['ordered_items']))
  2863. {
  2864. $this->data['ordered_items'] = $this->data['items'];
  2865. usort($this->data['ordered_items'], array(get_class($this), 'sort_items'));
  2866. }
  2867. $items = $this->data['ordered_items'];
  2868. }
  2869. else
  2870. {
  2871. $items = $this->data['items'];
  2872. }
  2873. // Slice the data as desired
  2874. if ($end === 0)
  2875. {
  2876. return array_slice($items, $start);
  2877. }
  2878. return array_slice($items, $start, $end);
  2879. }
  2880. /**
  2881. * Set the favicon handler
  2882. *
  2883. * @deprecated Use your own favicon handling instead
  2884. */
  2885. public function set_favicon_handler($page = false, $qs = 'i')
  2886. {
  2887. $level = defined('E_USER_DEPRECATED') ? E_USER_DEPRECATED : E_USER_WARNING;
  2888. trigger_error('Favicon handling has been removed, please use your own handling', $level);
  2889. return false;
  2890. }
  2891. /**
  2892. * Get the favicon for the current feed
  2893. *
  2894. * @deprecated Use your own favicon handling instead
  2895. */
  2896. public function get_favicon()
  2897. {
  2898. $level = defined('E_USER_DEPRECATED') ? E_USER_DEPRECATED : E_USER_WARNING;
  2899. trigger_error('Favicon handling has been removed, please use your own handling', $level);
  2900. if (($url = $this->get_link()) !== null)
  2901. {
  2902. return 'https://www.google.com/s2/favicons?domain=' . urlencode($url);
  2903. }
  2904. return false;
  2905. }
  2906. /**
  2907. * Magic method handler
  2908. *
  2909. * @param string $method Method name
  2910. * @param array $args Arguments to the method
  2911. * @return mixed
  2912. */
  2913. public function __call($method, $args)
  2914. {
  2915. if (strpos($method, 'subscribe_') === 0)
  2916. {
  2917. $level = defined('E_USER_DEPRECATED') ? E_USER_DEPRECATED : E_USER_WARNING;
  2918. trigger_error('subscribe_*() has been deprecated, implement the callback yourself', $level);
  2919. return '';
  2920. }
  2921. if ($method === 'enable_xml_dump')
  2922. {
  2923. $level = defined('E_USER_DEPRECATED') ? E_USER_DEPRECATED : E_USER_WARNING;
  2924. trigger_error('enable_xml_dump() has been deprecated, use get_raw_data() instead', $level);
  2925. return false;
  2926. }
  2927. $class = get_class($this);
  2928. $trace = debug_backtrace();
  2929. $file = $trace[0]['file'];
  2930. $line = $trace[0]['line'];
  2931. trigger_error("Call to undefined method $class::$method() in $file on line $line", E_USER_ERROR);
  2932. }
  2933. /**
  2934. * Sorting callback for items
  2935. *
  2936. * @access private
  2937. * @param SimplePie $a
  2938. * @param SimplePie $b
  2939. * @return boolean
  2940. */
  2941. public static function sort_items($a, $b)
  2942. {
  2943. $a_date = $a->get_date('U');
  2944. $b_date = $b->get_date('U');
  2945. if ($a_date && $b_date) {
  2946. return $a_date > $b_date ? -1 : 1;
  2947. }
  2948. // Sort items without dates to the top.
  2949. if ($a_date) {
  2950. return 1;
  2951. }
  2952. if ($b_date) {
  2953. return -1;
  2954. }
  2955. return 0;
  2956. }
  2957. /**
  2958. * Merge items from several feeds into one
  2959. *
  2960. * If you're merging multiple feeds together, they need to all have dates
  2961. * for the items or else SimplePie will refuse to sort them.
  2962. *
  2963. * @link http://simplepie.org/wiki/tutorial/sort_multiple_feeds_by_time_and_date#if_feeds_require_separate_per-feed_settings
  2964. * @param array $urls List of SimplePie feed objects to merge
  2965. * @param int $start Starting item
  2966. * @param int $end Number of items to return
  2967. * @param int $limit Maximum number of items per feed
  2968. * @return array
  2969. */
  2970. public static function merge_items($urls, $start = 0, $end = 0, $limit = 0)
  2971. {
  2972. if (is_array($urls) && sizeof($urls) > 0)
  2973. {
  2974. $items = array();
  2975. foreach ($urls as $arg)
  2976. {
  2977. if ($arg instanceof SimplePie)
  2978. {
  2979. $items = array_merge($items, $arg->get_items(0, $limit));
  2980. }
  2981. else
  2982. {
  2983. trigger_error('Arguments must be SimplePie objects', E_USER_WARNING);
  2984. }
  2985. }
  2986. usort($items, array(get_class($urls[0]), 'sort_items'));
  2987. if ($end === 0)
  2988. {
  2989. return array_slice($items, $start);
  2990. }
  2991. return array_slice($items, $start, $end);
  2992. }
  2993. trigger_error('Cannot merge zero SimplePie objects', E_USER_WARNING);
  2994. return array();
  2995. }
  2996. /**
  2997. * Store PubSubHubbub links as headers
  2998. *
  2999. * There is no way to find PuSH links in the body of a microformats feed,
  3000. * so they are added to the headers when found, to be used later by get_links.
  3001. * @param SimplePie_File $file
  3002. * @param string $hub
  3003. * @param string $self
  3004. */
  3005. private function store_links(&$file, $hub, $self) {
  3006. if (isset($file->headers['link']['hub']) ||
  3007. (isset($file->headers['link']) &&
  3008. preg_match('/rel=hub/', $file->headers['link'])))
  3009. {
  3010. return;
  3011. }
  3012. if ($hub)
  3013. {
  3014. if (isset($file->headers['link']))
  3015. {
  3016. if ($file->headers['link'] !== '')
  3017. {
  3018. $file->headers['link'] = ', ';
  3019. }
  3020. }
  3021. else
  3022. {
  3023. $file->headers['link'] = '';
  3024. }
  3025. $file->headers['link'] .= '<'.$hub.'>; rel=hub';
  3026. if ($self)
  3027. {
  3028. $file->headers['link'] .= ', <'.$self.'>; rel=self';
  3029. }
  3030. }
  3031. }
  3032. }