SimplePie.php 93 KB

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