SimplePie.php 87 KB

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