SimplePie.php 90 KB

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