SimplePie.php 90 KB

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