SimplePie.php 87 KB

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