SimplePie.php 95 KB

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