SimplePie.php 97 KB

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