SimplePie.php 88 KB

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