SimplePie.php 97 KB

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