From 8fcd2dc9b0c0afe411a334737e44721894e6a5b7 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 11:33:29 +0100 Subject: [PATCH 1/8] Add git ignore file to the project --- .gitignore | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/.gitignore b/.gitignore index 7579f74..abad765 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,81 @@ vendor composer.lock +### Example user template template +### Example user template + +# IntelliJ project files +.idea +*.iml +out +gen### OSX template +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk +### JetBrains template +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff: +.idea/workspace.xml +.idea/tasks.xml +.idea/dictionaries +.idea/vcs.xml +.idea/jsLibraryMappings.xml + +# Sensitive or high-churn files: +.idea/dataSources.ids +.idea/dataSources.xml +.idea/dataSources.local.xml +.idea/sqlDataSources.xml +.idea/dynamic.xml +.idea/uiDesigner.xml + +# Gradle: +.idea/gradle.xml +.idea/libraries + +# Mongo Explorer plugin: +.idea/mongoSettings.xml + +## File-based project format: +*.iws + +## Plugin-specific files: + +# IntelliJ +/out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + -- 2.46.2 From 5fcd580d3dd7f30b9aff0e9fc4f598364c50fff8 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 12:26:02 +0100 Subject: [PATCH 2/8] Add mobile detect function --- readme.txt => README.md | 6 + backends/mobile-detect.php | 1453 ++++++++++++++++++++++++++++++++++++ wp-ffpc-acache.php | 22 +- 3 files changed, 1478 insertions(+), 3 deletions(-) rename readme.txt => README.md (99%) create mode 100644 backends/mobile-detect.php diff --git a/readme.txt b/README.md similarity index 99% rename from readme.txt rename to README.md index f58986e..a4310d7 100644 --- a/readme.txt +++ b/README.md @@ -135,6 +135,12 @@ Version numbering logic: * every .B version indicates new features. * every ..C indicates bugfixes for A.B version. += 1.12.0 = +*2016-11-09* + +* Add new class to detect mobile devices +* Create a cache to mobile and desktop version + = 1.11.1 = *2016-04-21* diff --git a/backends/mobile-detect.php b/backends/mobile-detect.php new file mode 100644 index 0000000..aa26581 --- /dev/null +++ b/backends/mobile-detect.php @@ -0,0 +1,1453 @@ + + * Nick Ilyin + * + * Original author: Victor Stanciu + * + * @license Code and contributions have 'MIT License' + * More details: https://github.com/serbanghita/Mobile-Detect/blob/master/LICENSE.txt + * + * @link Homepage: http://mobiledetect.net + * GitHub Repo: https://github.com/serbanghita/Mobile-Detect + * Google Code: http://code.google.com/p/php-mobile-detect/ + * README: https://github.com/serbanghita/Mobile-Detect/blob/master/README.md + * HOWTO: https://github.com/serbanghita/Mobile-Detect/wiki/Code-examples + * + * @version 2.8.22 + */ + +class Mobile_Detect +{ + /** + * Mobile detection type. + * + * @deprecated since version 2.6.9 + */ + const DETECTION_TYPE_MOBILE = 'mobile'; + + /** + * Extended detection type. + * + * @deprecated since version 2.6.9 + */ + const DETECTION_TYPE_EXTENDED = 'extended'; + + /** + * A frequently used regular expression to extract version #s. + * + * @deprecated since version 2.6.9 + */ + const VER = '([\w._\+]+)'; + + /** + * Top-level device. + */ + const MOBILE_GRADE_A = 'A'; + + /** + * Mid-level device. + */ + const MOBILE_GRADE_B = 'B'; + + /** + * Low-level device. + */ + const MOBILE_GRADE_C = 'C'; + + /** + * Stores the version number of the current release. + */ + const VERSION = '2.8.22'; + + /** + * A type for the version() method indicating a string return value. + */ + const VERSION_TYPE_STRING = 'text'; + + /** + * A type for the version() method indicating a float return value. + */ + const VERSION_TYPE_FLOAT = 'float'; + + /** + * A cache for resolved matches + * @var array + */ + protected $cache = array(); + + /** + * The User-Agent HTTP header is stored in here. + * @var string + */ + protected $userAgent = null; + + /** + * HTTP headers in the PHP-flavor. So HTTP_USER_AGENT and SERVER_SOFTWARE. + * @var array + */ + protected $httpHeaders = array(); + + /** + * CloudFront headers. E.g. CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer & CloudFront-Is-Tablet-Viewer. + * @var array + */ + protected $cloudfrontHeaders = array(); + + /** + * The matching Regex. + * This is good for debug. + * @var string + */ + protected $matchingRegex = null; + + /** + * The matches extracted from the regex expression. + * This is good for debug. + * @var string + */ + protected $matchesArray = null; + + /** + * The detection type, using self::DETECTION_TYPE_MOBILE or self::DETECTION_TYPE_EXTENDED. + * + * @deprecated since version 2.6.9 + * + * @var string + */ + protected $detectionType = self::DETECTION_TYPE_MOBILE; + + /** + * HTTP headers that trigger the 'isMobile' detection + * to be true. + * + * @var array + */ + protected static $mobileHeaders = array( + + 'HTTP_ACCEPT' => array('matches' => array( + // Opera Mini; @reference: http://dev.opera.com/articles/view/opera-binary-markup-language/ + 'application/x-obml2d', + // BlackBerry devices. + 'application/vnd.rim.html', + 'text/vnd.wap.wml', + 'application/vnd.wap.xhtml+xml' + )), + 'HTTP_X_WAP_PROFILE' => null, + 'HTTP_X_WAP_CLIENTID' => null, + 'HTTP_WAP_CONNECTION' => null, + 'HTTP_PROFILE' => null, + // Reported by Opera on Nokia devices (eg. C3). + 'HTTP_X_OPERAMINI_PHONE_UA' => null, + 'HTTP_X_NOKIA_GATEWAY_ID' => null, + 'HTTP_X_ORANGE_ID' => null, + 'HTTP_X_VODAFONE_3GPDPCONTEXT' => null, + 'HTTP_X_HUAWEI_USERID' => null, + // Reported by Windows Smartphones. + 'HTTP_UA_OS' => null, + // Reported by Verizon, Vodafone proxy system. + 'HTTP_X_MOBILE_GATEWAY' => null, + // Seen this on HTC Sensation. SensationXE_Beats_Z715e. + 'HTTP_X_ATT_DEVICEID' => null, + // Seen this on a HTC. + 'HTTP_UA_CPU' => array('matches' => array('ARM')), + ); + + /** + * List of mobile devices (phones). + * + * @var array + */ + protected static $phoneDevices = array( + 'iPhone' => '\biPhone\b|\biPod\b', // |\biTunes + 'BlackBerry' => 'BlackBerry|\bBB10\b|rim[0-9]+', + 'HTC' => 'HTC|HTC.*(Sensation|Evo|Vision|Explorer|6800|8100|8900|A7272|S510e|C110e|Legend|Desire|T8282)|APX515CKT|Qtek9090|APA9292KT|HD_mini|Sensation.*Z710e|PG86100|Z715e|Desire.*(A8181|HD)|ADR6200|ADR6400L|ADR6425|001HT|Inspire 4G|Android.*\bEVO\b|T-Mobile G1|Z520m', + 'Nexus' => 'Nexus One|Nexus S|Galaxy.*Nexus|Android.*Nexus.*Mobile|Nexus 4|Nexus 5|Nexus 6', + // @todo: Is 'Dell Streak' a tablet or a phone? ;) + 'Dell' => 'Dell.*Streak|Dell.*Aero|Dell.*Venue|DELL.*Venue Pro|Dell Flash|Dell Smoke|Dell Mini 3iX|XCD28|XCD35|\b001DL\b|\b101DL\b|\bGS01\b', + 'Motorola' => 'Motorola|DROIDX|DROID BIONIC|\bDroid\b.*Build|Android.*Xoom|HRI39|MOT-|A1260|A1680|A555|A853|A855|A953|A955|A956|Motorola.*ELECTRIFY|Motorola.*i1|i867|i940|MB200|MB300|MB501|MB502|MB508|MB511|MB520|MB525|MB526|MB611|MB612|MB632|MB810|MB855|MB860|MB861|MB865|MB870|ME501|ME502|ME511|ME525|ME600|ME632|ME722|ME811|ME860|ME863|ME865|MT620|MT710|MT716|MT720|MT810|MT870|MT917|Motorola.*TITANIUM|WX435|WX445|XT300|XT301|XT311|XT316|XT317|XT319|XT320|XT390|XT502|XT530|XT531|XT532|XT535|XT603|XT610|XT611|XT615|XT681|XT701|XT702|XT711|XT720|XT800|XT806|XT860|XT862|XT875|XT882|XT883|XT894|XT901|XT907|XT909|XT910|XT912|XT928|XT926|XT915|XT919|XT925|XT1021|\bMoto E\b', + 'Samsung' => 'Samsung|SM-G9250|GT-19300|SGH-I337|BGT-S5230|GT-B2100|GT-B2700|GT-B2710|GT-B3210|GT-B3310|GT-B3410|GT-B3730|GT-B3740|GT-B5510|GT-B5512|GT-B5722|GT-B6520|GT-B7300|GT-B7320|GT-B7330|GT-B7350|GT-B7510|GT-B7722|GT-B7800|GT-C3010|GT-C3011|GT-C3060|GT-C3200|GT-C3212|GT-C3212I|GT-C3262|GT-C3222|GT-C3300|GT-C3300K|GT-C3303|GT-C3303K|GT-C3310|GT-C3322|GT-C3330|GT-C3350|GT-C3500|GT-C3510|GT-C3530|GT-C3630|GT-C3780|GT-C5010|GT-C5212|GT-C6620|GT-C6625|GT-C6712|GT-E1050|GT-E1070|GT-E1075|GT-E1080|GT-E1081|GT-E1085|GT-E1087|GT-E1100|GT-E1107|GT-E1110|GT-E1120|GT-E1125|GT-E1130|GT-E1160|GT-E1170|GT-E1175|GT-E1180|GT-E1182|GT-E1200|GT-E1210|GT-E1225|GT-E1230|GT-E1390|GT-E2100|GT-E2120|GT-E2121|GT-E2152|GT-E2220|GT-E2222|GT-E2230|GT-E2232|GT-E2250|GT-E2370|GT-E2550|GT-E2652|GT-E3210|GT-E3213|GT-I5500|GT-I5503|GT-I5700|GT-I5800|GT-I5801|GT-I6410|GT-I6420|GT-I7110|GT-I7410|GT-I7500|GT-I8000|GT-I8150|GT-I8160|GT-I8190|GT-I8320|GT-I8330|GT-I8350|GT-I8530|GT-I8700|GT-I8703|GT-I8910|GT-I9000|GT-I9001|GT-I9003|GT-I9010|GT-I9020|GT-I9023|GT-I9070|GT-I9082|GT-I9100|GT-I9103|GT-I9220|GT-I9250|GT-I9300|GT-I9305|GT-I9500|GT-I9505|GT-M3510|GT-M5650|GT-M7500|GT-M7600|GT-M7603|GT-M8800|GT-M8910|GT-N7000|GT-S3110|GT-S3310|GT-S3350|GT-S3353|GT-S3370|GT-S3650|GT-S3653|GT-S3770|GT-S3850|GT-S5210|GT-S5220|GT-S5229|GT-S5230|GT-S5233|GT-S5250|GT-S5253|GT-S5260|GT-S5263|GT-S5270|GT-S5300|GT-S5330|GT-S5350|GT-S5360|GT-S5363|GT-S5369|GT-S5380|GT-S5380D|GT-S5560|GT-S5570|GT-S5600|GT-S5603|GT-S5610|GT-S5620|GT-S5660|GT-S5670|GT-S5690|GT-S5750|GT-S5780|GT-S5830|GT-S5839|GT-S6102|GT-S6500|GT-S7070|GT-S7200|GT-S7220|GT-S7230|GT-S7233|GT-S7250|GT-S7500|GT-S7530|GT-S7550|GT-S7562|GT-S7710|GT-S8000|GT-S8003|GT-S8500|GT-S8530|GT-S8600|SCH-A310|SCH-A530|SCH-A570|SCH-A610|SCH-A630|SCH-A650|SCH-A790|SCH-A795|SCH-A850|SCH-A870|SCH-A890|SCH-A930|SCH-A950|SCH-A970|SCH-A990|SCH-I100|SCH-I110|SCH-I400|SCH-I405|SCH-I500|SCH-I510|SCH-I515|SCH-I600|SCH-I730|SCH-I760|SCH-I770|SCH-I830|SCH-I910|SCH-I920|SCH-I959|SCH-LC11|SCH-N150|SCH-N300|SCH-R100|SCH-R300|SCH-R351|SCH-R400|SCH-R410|SCH-T300|SCH-U310|SCH-U320|SCH-U350|SCH-U360|SCH-U365|SCH-U370|SCH-U380|SCH-U410|SCH-U430|SCH-U450|SCH-U460|SCH-U470|SCH-U490|SCH-U540|SCH-U550|SCH-U620|SCH-U640|SCH-U650|SCH-U660|SCH-U700|SCH-U740|SCH-U750|SCH-U810|SCH-U820|SCH-U900|SCH-U940|SCH-U960|SCS-26UC|SGH-A107|SGH-A117|SGH-A127|SGH-A137|SGH-A157|SGH-A167|SGH-A177|SGH-A187|SGH-A197|SGH-A227|SGH-A237|SGH-A257|SGH-A437|SGH-A517|SGH-A597|SGH-A637|SGH-A657|SGH-A667|SGH-A687|SGH-A697|SGH-A707|SGH-A717|SGH-A727|SGH-A737|SGH-A747|SGH-A767|SGH-A777|SGH-A797|SGH-A817|SGH-A827|SGH-A837|SGH-A847|SGH-A867|SGH-A877|SGH-A887|SGH-A897|SGH-A927|SGH-B100|SGH-B130|SGH-B200|SGH-B220|SGH-C100|SGH-C110|SGH-C120|SGH-C130|SGH-C140|SGH-C160|SGH-C170|SGH-C180|SGH-C200|SGH-C207|SGH-C210|SGH-C225|SGH-C230|SGH-C417|SGH-C450|SGH-D307|SGH-D347|SGH-D357|SGH-D407|SGH-D415|SGH-D780|SGH-D807|SGH-D980|SGH-E105|SGH-E200|SGH-E315|SGH-E316|SGH-E317|SGH-E335|SGH-E590|SGH-E635|SGH-E715|SGH-E890|SGH-F300|SGH-F480|SGH-I200|SGH-I300|SGH-I320|SGH-I550|SGH-I577|SGH-I600|SGH-I607|SGH-I617|SGH-I627|SGH-I637|SGH-I677|SGH-I700|SGH-I717|SGH-I727|SGH-i747M|SGH-I777|SGH-I780|SGH-I827|SGH-I847|SGH-I857|SGH-I896|SGH-I897|SGH-I900|SGH-I907|SGH-I917|SGH-I927|SGH-I937|SGH-I997|SGH-J150|SGH-J200|SGH-L170|SGH-L700|SGH-M110|SGH-M150|SGH-M200|SGH-N105|SGH-N500|SGH-N600|SGH-N620|SGH-N625|SGH-N700|SGH-N710|SGH-P107|SGH-P207|SGH-P300|SGH-P310|SGH-P520|SGH-P735|SGH-P777|SGH-Q105|SGH-R210|SGH-R220|SGH-R225|SGH-S105|SGH-S307|SGH-T109|SGH-T119|SGH-T139|SGH-T209|SGH-T219|SGH-T229|SGH-T239|SGH-T249|SGH-T259|SGH-T309|SGH-T319|SGH-T329|SGH-T339|SGH-T349|SGH-T359|SGH-T369|SGH-T379|SGH-T409|SGH-T429|SGH-T439|SGH-T459|SGH-T469|SGH-T479|SGH-T499|SGH-T509|SGH-T519|SGH-T539|SGH-T559|SGH-T589|SGH-T609|SGH-T619|SGH-T629|SGH-T639|SGH-T659|SGH-T669|SGH-T679|SGH-T709|SGH-T719|SGH-T729|SGH-T739|SGH-T746|SGH-T749|SGH-T759|SGH-T769|SGH-T809|SGH-T819|SGH-T839|SGH-T919|SGH-T929|SGH-T939|SGH-T959|SGH-T989|SGH-U100|SGH-U200|SGH-U800|SGH-V205|SGH-V206|SGH-X100|SGH-X105|SGH-X120|SGH-X140|SGH-X426|SGH-X427|SGH-X475|SGH-X495|SGH-X497|SGH-X507|SGH-X600|SGH-X610|SGH-X620|SGH-X630|SGH-X700|SGH-X820|SGH-X890|SGH-Z130|SGH-Z150|SGH-Z170|SGH-ZX10|SGH-ZX20|SHW-M110|SPH-A120|SPH-A400|SPH-A420|SPH-A460|SPH-A500|SPH-A560|SPH-A600|SPH-A620|SPH-A660|SPH-A700|SPH-A740|SPH-A760|SPH-A790|SPH-A800|SPH-A820|SPH-A840|SPH-A880|SPH-A900|SPH-A940|SPH-A960|SPH-D600|SPH-D700|SPH-D710|SPH-D720|SPH-I300|SPH-I325|SPH-I330|SPH-I350|SPH-I500|SPH-I600|SPH-I700|SPH-L700|SPH-M100|SPH-M220|SPH-M240|SPH-M300|SPH-M305|SPH-M320|SPH-M330|SPH-M350|SPH-M360|SPH-M370|SPH-M380|SPH-M510|SPH-M540|SPH-M550|SPH-M560|SPH-M570|SPH-M580|SPH-M610|SPH-M620|SPH-M630|SPH-M800|SPH-M810|SPH-M850|SPH-M900|SPH-M910|SPH-M920|SPH-M930|SPH-N100|SPH-N200|SPH-N240|SPH-N300|SPH-N400|SPH-Z400|SWC-E100|SCH-i909|GT-N7100|GT-N7105|SCH-I535|SM-N900A|SGH-I317|SGH-T999L|GT-S5360B|GT-I8262|GT-S6802|GT-S6312|GT-S6310|GT-S5312|GT-S5310|GT-I9105|GT-I8510|GT-S6790N|SM-G7105|SM-N9005|GT-S5301|GT-I9295|GT-I9195|SM-C101|GT-S7392|GT-S7560|GT-B7610|GT-I5510|GT-S7582|GT-S7530E|GT-I8750|SM-G9006V|SM-G9008V|SM-G9009D|SM-G900A|SM-G900D|SM-G900F|SM-G900H|SM-G900I|SM-G900J|SM-G900K|SM-G900L|SM-G900M|SM-G900P|SM-G900R4|SM-G900S|SM-G900T|SM-G900V|SM-G900W8|SHV-E160K|SCH-P709|SCH-P729|SM-T2558|GT-I9205|SM-G9350|SM-J120F', + 'LG' => '\bLG\b;|LG[- ]?(C800|C900|E400|E610|E900|E-900|F160|F180K|F180L|F180S|730|855|L160|LS740|LS840|LS970|LU6200|MS690|MS695|MS770|MS840|MS870|MS910|P500|P700|P705|VM696|AS680|AS695|AX840|C729|E970|GS505|272|C395|E739BK|E960|L55C|L75C|LS696|LS860|P769BK|P350|P500|P509|P870|UN272|US730|VS840|VS950|LN272|LN510|LS670|LS855|LW690|MN270|MN510|P509|P769|P930|UN200|UN270|UN510|UN610|US670|US740|US760|UX265|UX840|VN271|VN530|VS660|VS700|VS740|VS750|VS910|VS920|VS930|VX9200|VX11000|AX840A|LW770|P506|P925|P999|E612|D955|D802|MS323)', + 'Sony' => 'SonyST|SonyLT|SonyEricsson|SonyEricssonLT15iv|LT18i|E10i|LT28h|LT26w|SonyEricssonMT27i|C5303|C6902|C6903|C6906|C6943|D2533', + 'Asus' => 'Asus.*Galaxy|PadFone.*Mobile', + 'NokiaLumia' => 'Lumia [0-9]{3,4}', + // http://www.micromaxinfo.com/mobiles/smartphones + // Added because the codes might conflict with Acer Tablets. + 'Micromax' => 'Micromax.*\b(A210|A92|A88|A72|A111|A110Q|A115|A116|A110|A90S|A26|A51|A35|A54|A25|A27|A89|A68|A65|A57|A90)\b', + // @todo Complete the regex. + 'Palm' => 'PalmSource|Palm', // avantgo|blazer|elaine|hiptop|plucker|xiino ; + 'Vertu' => 'Vertu|Vertu.*Ltd|Vertu.*Ascent|Vertu.*Ayxta|Vertu.*Constellation(F|Quest)?|Vertu.*Monika|Vertu.*Signature', // Just for fun ;) + // http://www.pantech.co.kr/en/prod/prodList.do?gbrand=VEGA (PANTECH) + // Most of the VEGA devices are legacy. PANTECH seem to be newer devices based on Android. + 'Pantech' => 'PANTECH|IM-A850S|IM-A840S|IM-A830L|IM-A830K|IM-A830S|IM-A820L|IM-A810K|IM-A810S|IM-A800S|IM-T100K|IM-A725L|IM-A780L|IM-A775C|IM-A770K|IM-A760S|IM-A750K|IM-A740S|IM-A730S|IM-A720L|IM-A710K|IM-A690L|IM-A690S|IM-A650S|IM-A630K|IM-A600S|VEGA PTL21|PT003|P8010|ADR910L|P6030|P6020|P9070|P4100|P9060|P5000|CDM8992|TXT8045|ADR8995|IS11PT|P2030|P6010|P8000|PT002|IS06|CDM8999|P9050|PT001|TXT8040|P2020|P9020|P2000|P7040|P7000|C790', + // http://www.fly-phone.com/devices/smartphones/ ; Included only smartphones. + 'Fly' => 'IQ230|IQ444|IQ450|IQ440|IQ442|IQ441|IQ245|IQ256|IQ236|IQ255|IQ235|IQ245|IQ275|IQ240|IQ285|IQ280|IQ270|IQ260|IQ250', + // http://fr.wikomobile.com + 'Wiko' => 'KITE 4G|HIGHWAY|GETAWAY|STAIRWAY|DARKSIDE|DARKFULL|DARKNIGHT|DARKMOON|SLIDE|WAX 4G|RAINBOW|BLOOM|SUNSET|GOA(?!nna)|LENNY|BARRY|IGGY|OZZY|CINK FIVE|CINK PEAX|CINK PEAX 2|CINK SLIM|CINK SLIM 2|CINK +|CINK KING|CINK PEAX|CINK SLIM|SUBLIM', + 'iMobile' => 'i-mobile (IQ|i-STYLE|idea|ZAA|Hitz)', + // Added simvalley mobile just for fun. They have some interesting devices. + // http://www.simvalley.fr/telephonie---gps-_22_telephonie-mobile_telephones_.html + 'SimValley' => '\b(SP-80|XT-930|SX-340|XT-930|SX-310|SP-360|SP60|SPT-800|SP-120|SPT-800|SP-140|SPX-5|SPX-8|SP-100|SPX-8|SPX-12)\b', + // Wolfgang - a brand that is sold by Aldi supermarkets. + // http://www.wolfgangmobile.com/ + 'Wolfgang' => 'AT-B24D|AT-AS50HD|AT-AS40W|AT-AS55HD|AT-AS45q2|AT-B26D|AT-AS50Q', + 'Alcatel' => 'Alcatel', + 'Nintendo' => 'Nintendo 3DS', + // http://en.wikipedia.org/wiki/Amoi + 'Amoi' => 'Amoi', + // http://en.wikipedia.org/wiki/INQ + 'INQ' => 'INQ', + // @Tapatalk is a mobile app; http://support.tapatalk.com/threads/smf-2-0-2-os-and-browser-detection-plugin-and-tapatalk.15565/#post-79039 + 'GenericPhone' => 'Tapatalk|PDA;|SAGEM|\bmmp\b|pocket|\bpsp\b|symbian|Smartphone|smartfon|treo|up.browser|up.link|vodafone|\bwap\b|nokia|Series40|Series60|S60|SonyEricsson|N900|MAUI.*WAP.*Browser', + ); + + /** + * List of tablet devices. + * + * @var array + */ + protected static $tabletDevices = array( + // @todo: check for mobile friendly emails topic. + 'iPad' => 'iPad|iPad.*Mobile', + // Removed |^.*Android.*Nexus(?!(?:Mobile).)*$ + // @see #442 + 'NexusTablet' => 'Android.*Nexus[\s]+(7|9|10)', + 'SamsungTablet' => 'SAMSUNG.*Tablet|Galaxy.*Tab|SC-01C|GT-P1000|GT-P1003|GT-P1010|GT-P3105|GT-P6210|GT-P6800|GT-P6810|GT-P7100|GT-P7300|GT-P7310|GT-P7500|GT-P7510|SCH-I800|SCH-I815|SCH-I905|SGH-I957|SGH-I987|SGH-T849|SGH-T859|SGH-T869|SPH-P100|GT-P3100|GT-P3108|GT-P3110|GT-P5100|GT-P5110|GT-P6200|GT-P7320|GT-P7511|GT-N8000|GT-P8510|SGH-I497|SPH-P500|SGH-T779|SCH-I705|SCH-I915|GT-N8013|GT-P3113|GT-P5113|GT-P8110|GT-N8010|GT-N8005|GT-N8020|GT-P1013|GT-P6201|GT-P7501|GT-N5100|GT-N5105|GT-N5110|SHV-E140K|SHV-E140L|SHV-E140S|SHV-E150S|SHV-E230K|SHV-E230L|SHV-E230S|SHW-M180K|SHW-M180L|SHW-M180S|SHW-M180W|SHW-M300W|SHW-M305W|SHW-M380K|SHW-M380S|SHW-M380W|SHW-M430W|SHW-M480K|SHW-M480S|SHW-M480W|SHW-M485W|SHW-M486W|SHW-M500W|GT-I9228|SCH-P739|SCH-I925|GT-I9200|GT-P5200|GT-P5210|GT-P5210X|SM-T311|SM-T310|SM-T310X|SM-T210|SM-T210R|SM-T211|SM-P600|SM-P601|SM-P605|SM-P900|SM-P901|SM-T217|SM-T217A|SM-T217S|SM-P6000|SM-T3100|SGH-I467|XE500|SM-T110|GT-P5220|GT-I9200X|GT-N5110X|GT-N5120|SM-P905|SM-T111|SM-T2105|SM-T315|SM-T320|SM-T320X|SM-T321|SM-T520|SM-T525|SM-T530NU|SM-T230NU|SM-T330NU|SM-T900|XE500T1C|SM-P605V|SM-P905V|SM-T337V|SM-T537V|SM-T707V|SM-T807V|SM-P600X|SM-P900X|SM-T210X|SM-T230|SM-T230X|SM-T325|GT-P7503|SM-T531|SM-T330|SM-T530|SM-T705|SM-T705C|SM-T535|SM-T331|SM-T800|SM-T700|SM-T537|SM-T807|SM-P907A|SM-T337A|SM-T537A|SM-T707A|SM-T807A|SM-T237|SM-T807P|SM-P607T|SM-T217T|SM-T337T|SM-T807T|SM-T116NQ|SM-P550|SM-T350|SM-T550|SM-T9000|SM-P9000|SM-T705Y|SM-T805|GT-P3113|SM-T710|SM-T810|SM-T815|SM-T360|SM-T533|SM-T113|SM-T335|SM-T715|SM-T560|SM-T670|SM-T677|SM-T377|SM-T567|SM-T357T|SM-T555|SM-T561', // SCH-P709|SCH-P729|SM-T2558|GT-I9205 - Samsung Mega - treat them like a regular phone. + // http://docs.aws.amazon.com/silk/latest/developerguide/user-agent.html + 'Kindle' => 'Kindle|Silk.*Accelerated|Android.*\b(KFOT|KFTT|KFJWI|KFJWA|KFOTE|KFSOWI|KFTHWI|KFTHWA|KFAPWI|KFAPWA|WFJWAE|KFSAWA|KFSAWI|KFASWI|KFARWI)\b', + // Only the Surface tablets with Windows RT are considered mobile. + // http://msdn.microsoft.com/en-us/library/ie/hh920767(v=vs.85).aspx + 'SurfaceTablet' => 'Windows NT [0-9.]+; ARM;.*(Tablet|ARMBJS)', + // http://shopping1.hp.com/is-bin/INTERSHOP.enfinity/WFS/WW-USSMBPublicStore-Site/en_US/-/USD/ViewStandardCatalog-Browse?CatalogCategoryID=JfIQ7EN5lqMAAAEyDcJUDwMT + 'HPTablet' => 'HP Slate (7|8|10)|HP ElitePad 900|hp-tablet|EliteBook.*Touch|HP 8|Slate 21|HP SlateBook 10', + // Watch out for PadFone, see #132. + // http://www.asus.com/de/Tablets_Mobile/Memo_Pad_Products/ + 'AsusTablet' => '^.*PadFone((?!Mobile).)*$|Transformer|TF101|TF101G|TF300T|TF300TG|TF300TL|TF700T|TF700KL|TF701T|TF810C|ME171|ME301T|ME302C|ME371MG|ME370T|ME372MG|ME172V|ME173X|ME400C|Slider SL101|\bK00F\b|\bK00C\b|\bK00E\b|\bK00L\b|TX201LA|ME176C|ME102A|\bM80TA\b|ME372CL|ME560CG|ME372CG|ME302KL| K010 | K017 |ME572C|ME103K|ME170C|ME171C|\bME70C\b|ME581C|ME581CL|ME8510C|ME181C|P01Y|PO1MA', + 'BlackBerryTablet' => 'PlayBook|RIM Tablet', + 'HTCtablet' => 'HTC_Flyer_P512|HTC Flyer|HTC Jetstream|HTC-P715a|HTC EVO View 4G|PG41200|PG09410', + 'MotorolaTablet' => 'xoom|sholest|MZ615|MZ605|MZ505|MZ601|MZ602|MZ603|MZ604|MZ606|MZ607|MZ608|MZ609|MZ615|MZ616|MZ617', + 'NookTablet' => 'Android.*Nook|NookColor|nook browser|BNRV200|BNRV200A|BNTV250|BNTV250A|BNTV400|BNTV600|LogicPD Zoom2', + // http://www.acer.ro/ac/ro/RO/content/drivers + // http://www.packardbell.co.uk/pb/en/GB/content/download (Packard Bell is part of Acer) + // http://us.acer.com/ac/en/US/content/group/tablets + // http://www.acer.de/ac/de/DE/content/models/tablets/ + // Can conflict with Micromax and Motorola phones codes. + 'AcerTablet' => 'Android.*; \b(A100|A101|A110|A200|A210|A211|A500|A501|A510|A511|A700|A701|W500|W500P|W501|W501P|W510|W511|W700|G100|G100W|B1-A71|B1-710|B1-711|A1-810|A1-811|A1-830)\b|W3-810|\bA3-A10\b|\bA3-A11\b|\bA3-A20\b|\bA3-A30', + // http://eu.computers.toshiba-europe.com/innovation/family/Tablets/1098744/banner_id/tablet_footerlink/ + // http://us.toshiba.com/tablets/tablet-finder + // http://www.toshiba.co.jp/regza/tablet/ + 'ToshibaTablet' => 'Android.*(AT100|AT105|AT200|AT205|AT270|AT275|AT300|AT305|AT1S5|AT500|AT570|AT700|AT830)|TOSHIBA.*FOLIO', + // http://www.nttdocomo.co.jp/english/service/developer/smart_phone/technical_info/spec/index.html + // http://www.lg.com/us/tablets + 'LGTablet' => '\bL-06C|LG-V909|LG-V900|LG-V700|LG-V510|LG-V500|LG-V410|LG-V400|LG-VK810\b', + 'FujitsuTablet' => 'Android.*\b(F-01D|F-02F|F-05E|F-10D|M532|Q572)\b', + // Prestigio Tablets http://www.prestigio.com/support + 'PrestigioTablet' => 'PMP3170B|PMP3270B|PMP3470B|PMP7170B|PMP3370B|PMP3570C|PMP5870C|PMP3670B|PMP5570C|PMP5770D|PMP3970B|PMP3870C|PMP5580C|PMP5880D|PMP5780D|PMP5588C|PMP7280C|PMP7280C3G|PMP7280|PMP7880D|PMP5597D|PMP5597|PMP7100D|PER3464|PER3274|PER3574|PER3884|PER5274|PER5474|PMP5097CPRO|PMP5097|PMP7380D|PMP5297C|PMP5297C_QUAD|PMP812E|PMP812E3G|PMP812F|PMP810E|PMP880TD|PMT3017|PMT3037|PMT3047|PMT3057|PMT7008|PMT5887|PMT5001|PMT5002', + // http://support.lenovo.com/en_GB/downloads/default.page?# + 'LenovoTablet' => 'Lenovo TAB|Idea(Tab|Pad)( A1|A10| K1|)|ThinkPad([ ]+)?Tablet|YT3-X90L|YT3-X90F|YT3-X90X|Lenovo.*(S2109|S2110|S5000|S6000|K3011|A3000|A3500|A1000|A2107|A2109|A1107|A5500|A7600|B6000|B8000|B8080)(-|)(FL|F|HV|H|)', + // http://www.dell.com/support/home/us/en/04/Products/tab_mob/tablets + 'DellTablet' => 'Venue 11|Venue 8|Venue 7|Dell Streak 10|Dell Streak 7', + // http://www.yarvik.com/en/matrix/tablets/ + 'YarvikTablet' => 'Android.*\b(TAB210|TAB211|TAB224|TAB250|TAB260|TAB264|TAB310|TAB360|TAB364|TAB410|TAB411|TAB420|TAB424|TAB450|TAB460|TAB461|TAB464|TAB465|TAB467|TAB468|TAB07-100|TAB07-101|TAB07-150|TAB07-151|TAB07-152|TAB07-200|TAB07-201-3G|TAB07-210|TAB07-211|TAB07-212|TAB07-214|TAB07-220|TAB07-400|TAB07-485|TAB08-150|TAB08-200|TAB08-201-3G|TAB08-201-30|TAB09-100|TAB09-211|TAB09-410|TAB10-150|TAB10-201|TAB10-211|TAB10-400|TAB10-410|TAB13-201|TAB274EUK|TAB275EUK|TAB374EUK|TAB462EUK|TAB474EUK|TAB9-200)\b', + 'MedionTablet' => 'Android.*\bOYO\b|LIFE.*(P9212|P9514|P9516|S9512)|LIFETAB', + 'ArnovaTablet' => 'AN10G2|AN7bG3|AN7fG3|AN8G3|AN8cG3|AN7G3|AN9G3|AN7dG3|AN7dG3ST|AN7dG3ChildPad|AN10bG3|AN10bG3DT|AN9G2', + // http://www.intenso.de/kategorie_en.php?kategorie=33 + // @todo: http://www.nbhkdz.com/read/b8e64202f92a2df129126bff.html - investigate + 'IntensoTablet' => 'INM8002KP|INM1010FP|INM805ND|Intenso Tab|TAB1004', + // IRU.ru Tablets http://www.iru.ru/catalog/soho/planetable/ + 'IRUTablet' => 'M702pro', + 'MegafonTablet' => 'MegaFon V9|\bZTE V9\b|Android.*\bMT7A\b', + // http://www.e-boda.ro/tablete-pc.html + 'EbodaTablet' => 'E-Boda (Supreme|Impresspeed|Izzycomm|Essential)', + // http://www.allview.ro/produse/droseries/lista-tablete-pc/ + 'AllViewTablet' => 'Allview.*(Viva|Alldro|City|Speed|All TV|Frenzy|Quasar|Shine|TX1|AX1|AX2)', + // http://wiki.archosfans.com/index.php?title=Main_Page + 'ArchosTablet' => '\b(101G9|80G9|A101IT)\b|Qilive 97R|Archos5|\bARCHOS (70|79|80|90|97|101|FAMILYPAD|)(b|)(G10| Cobalt| TITANIUM(HD|)| Xenon| Neon|XSK| 2| XS 2| PLATINUM| CARBON|GAMEPAD)\b', + // http://www.ainol.com/plugin.php?identifier=ainol&module=product + 'AinolTablet' => 'NOVO7|NOVO8|NOVO10|Novo7Aurora|Novo7Basic|NOVO7PALADIN|novo9-Spark', + 'NokiaLumiaTablet' => 'Lumia 2520', + // @todo: inspect http://esupport.sony.com/US/p/select-system.pl?DIRECTOR=DRIVER + // Readers http://www.atsuhiro-me.net/ebook/sony-reader/sony-reader-web-browser + // http://www.sony.jp/support/tablet/ + 'SonyTablet' => 'Sony.*Tablet|Xperia Tablet|Sony Tablet S|SO-03E|SGPT12|SGPT13|SGPT114|SGPT121|SGPT122|SGPT123|SGPT111|SGPT112|SGPT113|SGPT131|SGPT132|SGPT133|SGPT211|SGPT212|SGPT213|SGP311|SGP312|SGP321|EBRD1101|EBRD1102|EBRD1201|SGP351|SGP341|SGP511|SGP512|SGP521|SGP541|SGP551|SGP621|SGP612|SOT31', + // http://www.support.philips.com/support/catalog/worldproducts.jsp?userLanguage=en&userCountry=cn&categoryid=3G_LTE_TABLET_SU_CN_CARE&title=3G%20tablets%20/%20LTE%20range&_dyncharset=UTF-8 + 'PhilipsTablet' => '\b(PI2010|PI3000|PI3100|PI3105|PI3110|PI3205|PI3210|PI3900|PI4010|PI7000|PI7100)\b', + // db + http://www.cube-tablet.com/buy-products.html + 'CubeTablet' => 'Android.*(K8GT|U9GT|U10GT|U16GT|U17GT|U18GT|U19GT|U20GT|U23GT|U30GT)|CUBE U8GT', + // http://www.cobyusa.com/?p=pcat&pcat_id=3001 + 'CobyTablet' => 'MID1042|MID1045|MID1125|MID1126|MID7012|MID7014|MID7015|MID7034|MID7035|MID7036|MID7042|MID7048|MID7127|MID8042|MID8048|MID8127|MID9042|MID9740|MID9742|MID7022|MID7010', + // http://www.match.net.cn/products.asp + 'MIDTablet' => 'M9701|M9000|M9100|M806|M1052|M806|T703|MID701|MID713|MID710|MID727|MID760|MID830|MID728|MID933|MID125|MID810|MID732|MID120|MID930|MID800|MID731|MID900|MID100|MID820|MID735|MID980|MID130|MID833|MID737|MID960|MID135|MID860|MID736|MID140|MID930|MID835|MID733|MID4X10', + // http://www.msi.com/support + // @todo Research the Windows Tablets. + 'MSITablet' => 'MSI \b(Primo 73K|Primo 73L|Primo 81L|Primo 77|Primo 93|Primo 75|Primo 76|Primo 73|Primo 81|Primo 91|Primo 90|Enjoy 71|Enjoy 7|Enjoy 10)\b', + // @todo http://www.kyoceramobile.com/support/drivers/ + // 'KyoceraTablet' => null, + // @todo http://intexuae.com/index.php/category/mobile-devices/tablets-products/ + // 'IntextTablet' => null, + // http://pdadb.net/index.php?m=pdalist&list=SMiT (NoName Chinese Tablets) + // http://www.imp3.net/14/show.php?itemid=20454 + 'SMiTTablet' => 'Android.*(\bMID\b|MID-560|MTV-T1200|MTV-PND531|MTV-P1101|MTV-PND530)', + // http://www.rock-chips.com/index.php?do=prod&pid=2 + 'RockChipTablet' => 'Android.*(RK2818|RK2808A|RK2918|RK3066)|RK2738|RK2808A', + // http://www.fly-phone.com/devices/tablets/ ; http://www.fly-phone.com/service/ + 'FlyTablet' => 'IQ310|Fly Vision', + // http://www.bqreaders.com/gb/tablets-prices-sale.html + 'bqTablet' => 'Android.*(bq)?.*(Elcano|Curie|Edison|Maxwell|Kepler|Pascal|Tesla|Hypatia|Platon|Newton|Livingstone|Cervantes|Avant|Aquaris E10)|Maxwell.*Lite|Maxwell.*Plus', + // http://www.huaweidevice.com/worldwide/productFamily.do?method=index&directoryId=5011&treeId=3290 + // http://www.huaweidevice.com/worldwide/downloadCenter.do?method=index&directoryId=3372&treeId=0&tb=1&type=software (including legacy tablets) + 'HuaweiTablet' => 'MediaPad|MediaPad 7 Youth|IDEOS S7|S7-201c|S7-202u|S7-101|S7-103|S7-104|S7-105|S7-106|S7-201|S7-Slim', + // Nec or Medias Tab + 'NecTablet' => '\bN-06D|\bN-08D', + // Pantech Tablets: http://www.pantechusa.com/phones/ + 'PantechTablet' => 'Pantech.*P4100', + // Broncho Tablets: http://www.broncho.cn/ (hard to find) + 'BronchoTablet' => 'Broncho.*(N701|N708|N802|a710)', + // http://versusuk.com/support.html + 'VersusTablet' => 'TOUCHPAD.*[78910]|\bTOUCHTAB\b', + // http://www.zync.in/index.php/our-products/tablet-phablets + 'ZyncTablet' => 'z1000|Z99 2G|z99|z930|z999|z990|z909|Z919|z900', + // http://www.positivoinformatica.com.br/www/pessoal/tablet-ypy/ + 'PositivoTablet' => 'TB07STA|TB10STA|TB07FTA|TB10FTA', + // https://www.nabitablet.com/ + 'NabiTablet' => 'Android.*\bNabi', + 'KoboTablet' => 'Kobo Touch|\bK080\b|\bVox\b Build|\bArc\b Build', + // French Danew Tablets http://www.danew.com/produits-tablette.php + 'DanewTablet' => 'DSlide.*\b(700|701R|702|703R|704|802|970|971|972|973|974|1010|1012)\b', + // Texet Tablets and Readers http://www.texet.ru/tablet/ + 'TexetTablet' => 'NaviPad|TB-772A|TM-7045|TM-7055|TM-9750|TM-7016|TM-7024|TM-7026|TM-7041|TM-7043|TM-7047|TM-8041|TM-9741|TM-9747|TM-9748|TM-9751|TM-7022|TM-7021|TM-7020|TM-7011|TM-7010|TM-7023|TM-7025|TM-7037W|TM-7038W|TM-7027W|TM-9720|TM-9725|TM-9737W|TM-1020|TM-9738W|TM-9740|TM-9743W|TB-807A|TB-771A|TB-727A|TB-725A|TB-719A|TB-823A|TB-805A|TB-723A|TB-715A|TB-707A|TB-705A|TB-709A|TB-711A|TB-890HD|TB-880HD|TB-790HD|TB-780HD|TB-770HD|TB-721HD|TB-710HD|TB-434HD|TB-860HD|TB-840HD|TB-760HD|TB-750HD|TB-740HD|TB-730HD|TB-722HD|TB-720HD|TB-700HD|TB-500HD|TB-470HD|TB-431HD|TB-430HD|TB-506|TB-504|TB-446|TB-436|TB-416|TB-146SE|TB-126SE', + // Avoid detecting 'PLAYSTATION 3' as mobile. + 'PlaystationTablet' => 'Playstation.*(Portable|Vita)', + // http://www.trekstor.de/surftabs.html + 'TrekstorTablet' => 'ST10416-1|VT10416-1|ST70408-1|ST702xx-1|ST702xx-2|ST80208|ST97216|ST70104-2|VT10416-2|ST10216-2A|SurfTab', + // http://www.pyleaudio.com/Products.aspx?%2fproducts%2fPersonal-Electronics%2fTablets + 'PyleAudioTablet' => '\b(PTBL10CEU|PTBL10C|PTBL72BC|PTBL72BCEU|PTBL7CEU|PTBL7C|PTBL92BC|PTBL92BCEU|PTBL9CEU|PTBL9CUK|PTBL9C)\b', + // http://www.advandigital.com/index.php?link=content-product&jns=JP001 + // because of the short codenames we have to include whitespaces to reduce the possible conflicts. + 'AdvanTablet' => 'Android.* \b(E3A|T3X|T5C|T5B|T3E|T3C|T3B|T1J|T1F|T2A|T1H|T1i|E1C|T1-E|T5-A|T4|E1-B|T2Ci|T1-B|T1-D|O1-A|E1-A|T1-A|T3A|T4i)\b ', + // http://www.danytech.com/category/tablet-pc + 'DanyTechTablet' => 'Genius Tab G3|Genius Tab S2|Genius Tab Q3|Genius Tab G4|Genius Tab Q4|Genius Tab G-II|Genius TAB GII|Genius TAB GIII|Genius Tab S1', + // http://www.galapad.net/product.html + 'GalapadTablet' => 'Android.*\bG1\b', + // http://www.micromaxinfo.com/tablet/funbook + 'MicromaxTablet' => 'Funbook|Micromax.*\b(P250|P560|P360|P362|P600|P300|P350|P500|P275)\b', + // http://www.karbonnmobiles.com/products_tablet.php + 'KarbonnTablet' => 'Android.*\b(A39|A37|A34|ST8|ST10|ST7|Smart Tab3|Smart Tab2)\b', + // http://www.myallfine.com/Products.asp + 'AllFineTablet' => 'Fine7 Genius|Fine7 Shine|Fine7 Air|Fine8 Style|Fine9 More|Fine10 Joy|Fine11 Wide', + // http://www.proscanvideo.com/products-search.asp?itemClass=TABLET&itemnmbr= + 'PROSCANTablet' => '\b(PEM63|PLT1023G|PLT1041|PLT1044|PLT1044G|PLT1091|PLT4311|PLT4311PL|PLT4315|PLT7030|PLT7033|PLT7033D|PLT7035|PLT7035D|PLT7044K|PLT7045K|PLT7045KB|PLT7071KG|PLT7072|PLT7223G|PLT7225G|PLT7777G|PLT7810K|PLT7849G|PLT7851G|PLT7852G|PLT8015|PLT8031|PLT8034|PLT8036|PLT8080K|PLT8082|PLT8088|PLT8223G|PLT8234G|PLT8235G|PLT8816K|PLT9011|PLT9045K|PLT9233G|PLT9735|PLT9760G|PLT9770G)\b', + // http://www.yonesnav.com/products/products.php + 'YONESTablet' => 'BQ1078|BC1003|BC1077|RK9702|BC9730|BC9001|IT9001|BC7008|BC7010|BC708|BC728|BC7012|BC7030|BC7027|BC7026', + // http://www.cjshowroom.com/eproducts.aspx?classcode=004001001 + // China manufacturer makes tablets for different small brands (eg. http://www.zeepad.net/index.html) + 'ChangJiaTablet' => 'TPC7102|TPC7103|TPC7105|TPC7106|TPC7107|TPC7201|TPC7203|TPC7205|TPC7210|TPC7708|TPC7709|TPC7712|TPC7110|TPC8101|TPC8103|TPC8105|TPC8106|TPC8203|TPC8205|TPC8503|TPC9106|TPC9701|TPC97101|TPC97103|TPC97105|TPC97106|TPC97111|TPC97113|TPC97203|TPC97603|TPC97809|TPC97205|TPC10101|TPC10103|TPC10106|TPC10111|TPC10203|TPC10205|TPC10503', + // http://www.gloryunion.cn/products.asp + // http://www.allwinnertech.com/en/apply/mobile.html + // http://www.ptcl.com.pk/pd_content.php?pd_id=284 (EVOTAB) + // @todo: Softwiner tablets? + // aka. Cute or Cool tablets. Not sure yet, must research to avoid collisions. + 'GUTablet' => 'TX-A1301|TX-M9002|Q702|kf026', // A12R|D75A|D77|D79|R83|A95|A106C|R15|A75|A76|D71|D72|R71|R73|R77|D82|R85|D92|A97|D92|R91|A10F|A77F|W71F|A78F|W78F|W81F|A97F|W91F|W97F|R16G|C72|C73E|K72|K73|R96G + // http://www.pointofview-online.com/showroom.php?shop_mode=product_listing&category_id=118 + 'PointOfViewTablet' => 'TAB-P506|TAB-navi-7-3G-M|TAB-P517|TAB-P-527|TAB-P701|TAB-P703|TAB-P721|TAB-P731N|TAB-P741|TAB-P825|TAB-P905|TAB-P925|TAB-PR945|TAB-PL1015|TAB-P1025|TAB-PI1045|TAB-P1325|TAB-PROTAB[0-9]+|TAB-PROTAB25|TAB-PROTAB26|TAB-PROTAB27|TAB-PROTAB26XL|TAB-PROTAB2-IPS9|TAB-PROTAB30-IPS9|TAB-PROTAB25XXL|TAB-PROTAB26-IPS10|TAB-PROTAB30-IPS10', + // http://www.overmax.pl/pl/katalog-produktow,p8/tablety,c14/ + // @todo: add more tests. + 'OvermaxTablet' => 'OV-(SteelCore|NewBase|Basecore|Baseone|Exellen|Quattor|EduTab|Solution|ACTION|BasicTab|TeddyTab|MagicTab|Stream|TB-08|TB-09)', + // http://hclmetablet.com/India/index.php + 'HCLTablet' => 'HCL.*Tablet|Connect-3G-2.0|Connect-2G-2.0|ME Tablet U1|ME Tablet U2|ME Tablet G1|ME Tablet X1|ME Tablet Y2|ME Tablet Sync', + // http://www.edigital.hu/Tablet_es_e-book_olvaso/Tablet-c18385.html + 'DPSTablet' => 'DPS Dream 9|DPS Dual 7', + // http://www.visture.com/index.asp + 'VistureTablet' => 'V97 HD|i75 3G|Visture V4( HD)?|Visture V5( HD)?|Visture V10', + // http://www.mijncresta.nl/tablet + 'CrestaTablet' => 'CTP(-)?810|CTP(-)?818|CTP(-)?828|CTP(-)?838|CTP(-)?888|CTP(-)?978|CTP(-)?980|CTP(-)?987|CTP(-)?988|CTP(-)?989', + // MediaTek - http://www.mediatek.com/_en/01_products/02_proSys.php?cata_sn=1&cata1_sn=1&cata2_sn=309 + 'MediatekTablet' => '\bMT8125|MT8389|MT8135|MT8377\b', + // Concorde tab + 'ConcordeTablet' => 'Concorde([ ]+)?Tab|ConCorde ReadMan', + // GoClever Tablets - http://www.goclever.com/uk/products,c1/tablet,c5/ + 'GoCleverTablet' => 'GOCLEVER TAB|A7GOCLEVER|M1042|M7841|M742|R1042BK|R1041|TAB A975|TAB A7842|TAB A741|TAB A741L|TAB M723G|TAB M721|TAB A1021|TAB I921|TAB R721|TAB I720|TAB T76|TAB R70|TAB R76.2|TAB R106|TAB R83.2|TAB M813G|TAB I721|GCTA722|TAB I70|TAB I71|TAB S73|TAB R73|TAB R74|TAB R93|TAB R75|TAB R76.1|TAB A73|TAB A93|TAB A93.2|TAB T72|TAB R83|TAB R974|TAB R973|TAB A101|TAB A103|TAB A104|TAB A104.2|R105BK|M713G|A972BK|TAB A971|TAB R974.2|TAB R104|TAB R83.3|TAB A1042', + // Modecom Tablets - http://www.modecom.eu/tablets/portal/ + 'ModecomTablet' => 'FreeTAB 9000|FreeTAB 7.4|FreeTAB 7004|FreeTAB 7800|FreeTAB 2096|FreeTAB 7.5|FreeTAB 1014|FreeTAB 1001 |FreeTAB 8001|FreeTAB 9706|FreeTAB 9702|FreeTAB 7003|FreeTAB 7002|FreeTAB 1002|FreeTAB 7801|FreeTAB 1331|FreeTAB 1004|FreeTAB 8002|FreeTAB 8014|FreeTAB 9704|FreeTAB 1003', + // Vonino Tablets - http://www.vonino.eu/tablets + 'VoninoTablet' => '\b(Argus[ _]?S|Diamond[ _]?79HD|Emerald[ _]?78E|Luna[ _]?70C|Onyx[ _]?S|Onyx[ _]?Z|Orin[ _]?HD|Orin[ _]?S|Otis[ _]?S|SpeedStar[ _]?S|Magnet[ _]?M9|Primus[ _]?94[ _]?3G|Primus[ _]?94HD|Primus[ _]?QS|Android.*\bQ8\b|Sirius[ _]?EVO[ _]?QS|Sirius[ _]?QS|Spirit[ _]?S)\b', + // ECS Tablets - http://www.ecs.com.tw/ECSWebSite/Product/Product_Tablet_List.aspx?CategoryID=14&MenuID=107&childid=M_107&LanID=0 + 'ECSTablet' => 'V07OT2|TM105A|S10OT1|TR10CS1', + // Storex Tablets - http://storex.fr/espace_client/support.html + // @note: no need to add all the tablet codes since they are guided by the first regex. + 'StorexTablet' => 'eZee[_\']?(Tab|Go)[0-9]+|TabLC7|Looney Tunes Tab', + // Generic Vodafone tablets. + 'VodafoneTablet' => 'SmartTab([ ]+)?[0-9]+|SmartTabII10|SmartTabII7|VF-1497', + // French tablets - Essentiel B http://www.boulanger.fr/tablette_tactile_e-book/tablette_tactile_essentiel_b/cl_68908.htm?multiChoiceToDelete=brand&mc_brand=essentielb + // Aka: http://www.essentielb.fr/ + 'EssentielBTablet' => 'Smart[ \']?TAB[ ]+?[0-9]+|Family[ \']?TAB2', + // Ross & Moor - http://ross-moor.ru/ + 'RossMoorTablet' => 'RM-790|RM-997|RMD-878G|RMD-974R|RMT-705A|RMT-701|RME-601|RMT-501|RMT-711', + // i-mobile http://product.i-mobilephone.com/Mobile_Device + 'iMobileTablet' => 'i-mobile i-note', + // http://www.tolino.de/de/vergleichen/ + 'TolinoTablet' => 'tolino tab [0-9.]+|tolino shine', + // AudioSonic - a Kmart brand + // http://www.kmart.com.au/webapp/wcs/stores/servlet/Search?langId=-1&storeId=10701&catalogId=10001&categoryId=193001&pageSize=72¤tPage=1&searchCategory=193001%2b4294965664&sortBy=p_MaxPrice%7c1 + 'AudioSonicTablet' => '\bC-22Q|T7-QC|T-17B|T-17P\b', + // AMPE Tablets - http://www.ampe.com.my/product-category/tablets/ + // @todo: add them gradually to avoid conflicts. + 'AMPETablet' => 'Android.* A78 ', + // Skk Mobile - http://skkmobile.com.ph/product_tablets.php + 'SkkTablet' => 'Android.* (SKYPAD|PHOENIX|CYCLOPS)', + // Tecno Mobile (only tablet) - http://www.tecno-mobile.com/index.php/product?filterby=smart&list_order=all&page=1 + 'TecnoTablet' => 'TECNO P9', + // JXD (consoles & tablets) - http://jxd.hk/products.asp?selectclassid=009008&clsid=3 + 'JXDTablet' => 'Android.* \b(F3000|A3300|JXD5000|JXD3000|JXD2000|JXD300B|JXD300|S5800|S7800|S602b|S5110b|S7300|S5300|S602|S603|S5100|S5110|S601|S7100a|P3000F|P3000s|P101|P200s|P1000m|P200m|P9100|P1000s|S6600b|S908|P1000|P300|S18|S6600|S9100)\b', + // i-Joy tablets - http://www.i-joy.es/en/cat/products/tablets/ + 'iJoyTablet' => 'Tablet (Spirit 7|Essentia|Galatea|Fusion|Onix 7|Landa|Titan|Scooby|Deox|Stella|Themis|Argon|Unique 7|Sygnus|Hexen|Finity 7|Cream|Cream X2|Jade|Neon 7|Neron 7|Kandy|Scape|Saphyr 7|Rebel|Biox|Rebel|Rebel 8GB|Myst|Draco 7|Myst|Tab7-004|Myst|Tadeo Jones|Tablet Boing|Arrow|Draco Dual Cam|Aurix|Mint|Amity|Revolution|Finity 9|Neon 9|T9w|Amity 4GB Dual Cam|Stone 4GB|Stone 8GB|Andromeda|Silken|X2|Andromeda II|Halley|Flame|Saphyr 9,7|Touch 8|Planet|Triton|Unique 10|Hexen 10|Memphis 4GB|Memphis 8GB|Onix 10)', + // http://www.intracon.eu/tablet + 'FX2Tablet' => 'FX2 PAD7|FX2 PAD10', + // http://www.xoro.de/produkte/ + // @note: Might be the same brand with 'Simply tablets' + 'XoroTablet' => 'KidsPAD 701|PAD[ ]?712|PAD[ ]?714|PAD[ ]?716|PAD[ ]?717|PAD[ ]?718|PAD[ ]?720|PAD[ ]?721|PAD[ ]?722|PAD[ ]?790|PAD[ ]?792|PAD[ ]?900|PAD[ ]?9715D|PAD[ ]?9716DR|PAD[ ]?9718DR|PAD[ ]?9719QR|PAD[ ]?9720QR|TelePAD1030|Telepad1032|TelePAD730|TelePAD731|TelePAD732|TelePAD735Q|TelePAD830|TelePAD9730|TelePAD795|MegaPAD 1331|MegaPAD 1851|MegaPAD 2151', + // http://www1.viewsonic.com/products/computing/tablets/ + 'ViewsonicTablet' => 'ViewPad 10pi|ViewPad 10e|ViewPad 10s|ViewPad E72|ViewPad7|ViewPad E100|ViewPad 7e|ViewSonic VB733|VB100a', + // http://www.odys.de/web/internet-tablet_en.html + 'OdysTablet' => 'LOOX|XENO10|ODYS[ -](Space|EVO|Xpress|NOON)|\bXELIO\b|Xelio10Pro|XELIO7PHONETAB|XELIO10EXTREME|XELIOPT2|NEO_QUAD10', + // http://www.captiva-power.de/products.html#tablets-en + 'CaptivaTablet' => 'CAPTIVA PAD', + // IconBIT - http://www.iconbit.com/products/tablets/ + 'IconbitTablet' => 'NetTAB|NT-3702|NT-3702S|NT-3702S|NT-3603P|NT-3603P|NT-0704S|NT-0704S|NT-3805C|NT-3805C|NT-0806C|NT-0806C|NT-0909T|NT-0909T|NT-0907S|NT-0907S|NT-0902S|NT-0902S', + // http://www.teclast.com/topic.php?channelID=70&topicID=140&pid=63 + 'TeclastTablet' => 'T98 4G|\bP80\b|\bX90HD\b|X98 Air|X98 Air 3G|\bX89\b|P80 3G|\bX80h\b|P98 Air|\bX89HD\b|P98 3G|\bP90HD\b|P89 3G|X98 3G|\bP70h\b|P79HD 3G|G18d 3G|\bP79HD\b|\bP89s\b|\bA88\b|\bP10HD\b|\bP19HD\b|G18 3G|\bP78HD\b|\bA78\b|\bP75\b|G17s 3G|G17h 3G|\bP85t\b|\bP90\b|\bP11\b|\bP98t\b|\bP98HD\b|\bG18d\b|\bP85s\b|\bP11HD\b|\bP88s\b|\bA80HD\b|\bA80se\b|\bA10h\b|\bP89\b|\bP78s\b|\bG18\b|\bP85\b|\bA70h\b|\bA70\b|\bG17\b|\bP18\b|\bA80s\b|\bA11s\b|\bP88HD\b|\bA80h\b|\bP76s\b|\bP76h\b|\bP98\b|\bA10HD\b|\bP78\b|\bP88\b|\bA11\b|\bA10t\b|\bP76a\b|\bP76t\b|\bP76e\b|\bP85HD\b|\bP85a\b|\bP86\b|\bP75HD\b|\bP76v\b|\bA12\b|\bP75a\b|\bA15\b|\bP76Ti\b|\bP81HD\b|\bA10\b|\bT760VE\b|\bT720HD\b|\bP76\b|\bP73\b|\bP71\b|\bP72\b|\bT720SE\b|\bC520Ti\b|\bT760\b|\bT720VE\b|T720-3GE|T720-WiFi', + // Onda - http://www.onda-tablet.com/buy-android-onda.html?dir=desc&limit=all&order=price + 'OndaTablet' => '\b(V975i|Vi30|VX530|V701|Vi60|V701s|Vi50|V801s|V719|Vx610w|VX610W|V819i|Vi10|VX580W|Vi10|V711s|V813|V811|V820w|V820|Vi20|V711|VI30W|V712|V891w|V972|V819w|V820w|Vi60|V820w|V711|V813s|V801|V819|V975s|V801|V819|V819|V818|V811|V712|V975m|V101w|V961w|V812|V818|V971|V971s|V919|V989|V116w|V102w|V973|Vi40)\b[\s]+', + 'JaytechTablet' => 'TPC-PA762', + 'BlaupunktTablet' => 'Endeavour 800NG|Endeavour 1010', + // http://www.digma.ru/support/download/ + // @todo: Ebooks also (if requested) + 'DigmaTablet' => '\b(iDx10|iDx9|iDx8|iDx7|iDxD7|iDxD8|iDsQ8|iDsQ7|iDsQ8|iDsD10|iDnD7|3TS804H|iDsQ11|iDj7|iDs10)\b', + // http://www.evolioshop.com/ro/tablete-pc.html + // http://www.evolio.ro/support/downloads_static.html?cat=2 + // @todo: Research some more + 'EvolioTablet' => 'ARIA_Mini_wifi|Aria[ _]Mini|Evolio X10|Evolio X7|Evolio X8|\bEvotab\b|\bNeura\b', + // @todo http://www.lavamobiles.com/tablets-data-cards + 'LavaTablet' => 'QPAD E704|\bIvoryS\b|E-TAB IVORY|\bE-TAB\b', + // http://www.breezetablet.com/ + 'AocTablet' => 'MW0811|MW0812|MW0922|MTK8382|MW1031|MW0831|MW0821|MW0931|MW0712', + // http://www.mpmaneurope.com/en/products/internet-tablets-14/android-tablets-14/ + 'MpmanTablet' => 'MP11 OCTA|MP10 OCTA|MPQC1114|MPQC1004|MPQC994|MPQC974|MPQC973|MPQC804|MPQC784|MPQC780|\bMPG7\b|MPDCG75|MPDCG71|MPDC1006|MP101DC|MPDC9000|MPDC905|MPDC706HD|MPDC706|MPDC705|MPDC110|MPDC100|MPDC99|MPDC97|MPDC88|MPDC8|MPDC77|MP709|MID701|MID711|MID170|MPDC703|MPQC1010', + // https://www.celkonmobiles.com/?_a=categoryphones&sid=2 + 'CelkonTablet' => 'CT695|CT888|CT[\s]?910|CT7 Tab|CT9 Tab|CT3 Tab|CT2 Tab|CT1 Tab|C820|C720|\bCT-1\b', + // http://www.wolderelectronics.com/productos/manuales-y-guias-rapidas/categoria-2-miTab + 'WolderTablet' => 'miTab \b(DIAMOND|SPACE|BROOKLYN|NEO|FLY|MANHATTAN|FUNK|EVOLUTION|SKY|GOCAR|IRON|GENIUS|POP|MINT|EPSILON|BROADWAY|JUMP|HOP|LEGEND|NEW AGE|LINE|ADVANCE|FEEL|FOLLOW|LIKE|LINK|LIVE|THINK|FREEDOM|CHICAGO|CLEVELAND|BALTIMORE-GH|IOWA|BOSTON|SEATTLE|PHOENIX|DALLAS|IN 101|MasterChef)\b', + // http://www.mi.com/en + 'MiTablet' => '\bMI PAD\b|\bHM NOTE 1W\b', + // http://www.nbru.cn/index.html + 'NibiruTablet' => 'Nibiru M1|Nibiru Jupiter One', + // http://navroad.com/products/produkty/tablety/ + 'NexoTablet' => 'NEXO NOVA|NEXO 10|NEXO AVIO|NEXO FREE|NEXO GO|NEXO EVO|NEXO 3G|NEXO SMART|NEXO KIDDO|NEXO MOBI', + // http://leader-online.com/new_site/product-category/tablets/ + // http://www.leader-online.net.au/List/Tablet + 'LeaderTablet' => 'TBLT10Q|TBLT10I|TBL-10WDKB|TBL-10WDKBO2013|TBL-W230V2|TBL-W450|TBL-W500|SV572|TBLT7I|TBA-AC7-8G|TBLT79|TBL-8W16|TBL-10W32|TBL-10WKB|TBL-W100', + // http://www.datawind.com/ubislate/ + 'UbislateTablet' => 'UbiSlate[\s]?7C', + // http://www.pocketbook-int.com/ru/support + 'PocketBookTablet' => 'Pocketbook', + // http://www.kocaso.com/product_tablet.html + 'KocasoTablet' => '\b(TB-1207)\b', + // http://www.tesco.com/direct/hudl/ + 'Hudl' => 'Hudl HT7S3|Hudl 2', + // http://www.telstra.com.au/home-phone/thub-2/ + 'TelstraTablet' => 'T-Hub2', + 'GenericTablet' => 'Android.*\b97D\b|Tablet(?!.*PC)|BNTV250A|MID-WCDMA|LogicPD Zoom2|\bA7EB\b|CatNova8|A1_07|CT704|CT1002|\bM721\b|rk30sdk|\bEVOTAB\b|M758A|ET904|ALUMIUM10|Smartfren Tab|Endeavour 1010|Tablet-PC-4|Tagi Tab|\bM6pro\b|CT1020W|arc 10HD|\bJolla\b|\bTP750\b' + ); + + /** + * List of mobile Operating Systems. + * + * @var array + */ + protected static $operatingSystems = array( + 'AndroidOS' => 'Android', + 'BlackBerryOS' => 'blackberry|\bBB10\b|rim tablet os', + 'PalmOS' => 'PalmOS|avantgo|blazer|elaine|hiptop|palm|plucker|xiino', + 'SymbianOS' => 'Symbian|SymbOS|Series60|Series40|SYB-[0-9]+|\bS60\b', + // @reference: http://en.wikipedia.org/wiki/Windows_Mobile + 'WindowsMobileOS' => 'Windows CE.*(PPC|Smartphone|Mobile|[0-9]{3}x[0-9]{3})|Window Mobile|Windows Phone [0-9.]+|WCE;', + // @reference: http://en.wikipedia.org/wiki/Windows_Phone + // http://wifeng.cn/?r=blog&a=view&id=106 + // http://nicksnettravels.builttoroam.com/post/2011/01/10/Bogus-Windows-Phone-7-User-Agent-String.aspx + // http://msdn.microsoft.com/library/ms537503.aspx + // https://msdn.microsoft.com/en-us/library/hh869301(v=vs.85).aspx + 'WindowsPhoneOS' => 'Windows Phone 10.0|Windows Phone 8.1|Windows Phone 8.0|Windows Phone OS|XBLWP7|ZuneWP7|Windows NT 6.[23]; ARM;', + 'iOS' => '\biPhone.*Mobile|\biPod|\biPad', + // http://en.wikipedia.org/wiki/MeeGo + // @todo: research MeeGo in UAs + 'MeeGoOS' => 'MeeGo', + // http://en.wikipedia.org/wiki/Maemo + // @todo: research Maemo in UAs + 'MaemoOS' => 'Maemo', + 'JavaOS' => 'J2ME/|\bMIDP\b|\bCLDC\b', // '|Java/' produces bug #135 + 'webOS' => 'webOS|hpwOS', + 'badaOS' => '\bBada\b', + 'BREWOS' => 'BREW', + ); + + /** + * List of mobile User Agents. + * + * @var array + */ + protected static $browsers = array( + 'Vivaldi' => 'Vivaldi', + // @reference: https://developers.google.com/chrome/mobile/docs/user-agent + 'Chrome' => '\bCrMo\b|CriOS|Android.*Chrome/[.0-9]* (Mobile)?', + 'Dolfin' => '\bDolfin\b', + 'Opera' => 'Opera.*Mini|Opera.*Mobi|Android.*Opera|Mobile.*OPR/[0-9.]+|Coast/[0-9.]+', + 'Skyfire' => 'Skyfire', + 'Edge' => 'Mobile Safari/[.0-9]* Edge', + 'IE' => 'IEMobile|MSIEMobile', // |Trident/[.0-9]+ + 'Firefox' => 'fennec|firefox.*maemo|(Mobile|Tablet).*Firefox|Firefox.*Mobile', + 'Bolt' => 'bolt', + 'TeaShark' => 'teashark', + 'Blazer' => 'Blazer', + // @reference: http://developer.apple.com/library/safari/#documentation/AppleApplications/Reference/SafariWebContent/OptimizingforSafarioniPhone/OptimizingforSafarioniPhone.html#//apple_ref/doc/uid/TP40006517-SW3 + 'Safari' => 'Version.*Mobile.*Safari|Safari.*Mobile|MobileSafari', + // http://en.wikipedia.org/wiki/Midori_(web_browser) + //'Midori' => 'midori', + 'Tizen' => 'Tizen', + 'UCBrowser' => 'UC.*Browser|UCWEB', + 'baiduboxapp' => 'baiduboxapp', + 'baidubrowser' => 'baidubrowser', + // https://github.com/serbanghita/Mobile-Detect/issues/7 + 'DiigoBrowser' => 'DiigoBrowser', + // http://www.puffinbrowser.com/index.php + 'Puffin' => 'Puffin', + // http://mercury-browser.com/index.html + 'Mercury' => '\bMercury\b', + // http://en.wikipedia.org/wiki/Obigo_Browser + 'ObigoBrowser' => 'Obigo', + // http://en.wikipedia.org/wiki/NetFront + 'NetFront' => 'NF-Browser', + // @reference: http://en.wikipedia.org/wiki/Minimo + // http://en.wikipedia.org/wiki/Vision_Mobile_Browser + 'GenericBrowser' => 'NokiaBrowser|OviBrowser|OneBrowser|TwonkyBeamBrowser|SEMC.*Browser|FlyFlow|Minimo|NetFront|Novarra-Vision|MQQBrowser|MicroMessenger', + // @reference: https://en.wikipedia.org/wiki/Pale_Moon_(web_browser) + 'PaleMoon' => 'Android.*PaleMoon|Mobile.*PaleMoon', + ); + + /** + * Utilities. + * + * @var array + */ + protected static $utilities = array( + // Experimental. When a mobile device wants to switch to 'Desktop Mode'. + // http://scottcate.com/technology/windows-phone-8-ie10-desktop-or-mobile/ + // https://github.com/serbanghita/Mobile-Detect/issues/57#issuecomment-15024011 + // https://developers.facebook.com/docs/sharing/best-practices + 'Bot' => 'Googlebot|facebookexternalhit|AdsBot-Google|Google Keyword Suggestion|Facebot|YandexBot|bingbot|ia_archiver|AhrefsBot|Ezooms|GSLFbot|WBSearchBot|Twitterbot|TweetmemeBot|Twikle|PaperLiBot|Wotbox|UnwindFetchor|Exabot|MJ12bot|YandexImages|TurnitinBot|Pingdom', + 'MobileBot' => 'Googlebot-Mobile|AdsBot-Google-Mobile|YahooSeeker/M1A1-R2D2', + 'DesktopMode' => 'WPDesktop', + 'TV' => 'SonyDTV|HbbTV', // experimental + 'WebKit' => '(webkit)[ /]([\w.]+)', + // @todo: Include JXD consoles. + 'Console' => '\b(Nintendo|Nintendo WiiU|Nintendo 3DS|PLAYSTATION|Xbox)\b', + 'Watch' => 'SM-V700', + ); + + /** + * All possible HTTP headers that represent the + * User-Agent string. + * + * @var array + */ + protected static $uaHttpHeaders = array( + // The default User-Agent string. + 'HTTP_USER_AGENT', + // Header can occur on devices using Opera Mini. + 'HTTP_X_OPERAMINI_PHONE_UA', + // Vodafone specific header: http://www.seoprinciple.com/mobile-web-community-still-angry-at-vodafone/24/ + 'HTTP_X_DEVICE_USER_AGENT', + 'HTTP_X_ORIGINAL_USER_AGENT', + 'HTTP_X_SKYFIRE_PHONE', + 'HTTP_X_BOLT_PHONE_UA', + 'HTTP_DEVICE_STOCK_UA', + 'HTTP_X_UCBROWSER_DEVICE_UA' + ); + + /** + * The individual segments that could exist in a User-Agent string. VER refers to the regular + * expression defined in the constant self::VER. + * + * @var array + */ + protected static $properties = array( + + // Build + 'Mobile' => 'Mobile/[VER]', + 'Build' => 'Build/[VER]', + 'Version' => 'Version/[VER]', + 'VendorID' => 'VendorID/[VER]', + + // Devices + 'iPad' => 'iPad.*CPU[a-z ]+[VER]', + 'iPhone' => 'iPhone.*CPU[a-z ]+[VER]', + 'iPod' => 'iPod.*CPU[a-z ]+[VER]', + //'BlackBerry' => array('BlackBerry[VER]', 'BlackBerry [VER];'), + 'Kindle' => 'Kindle/[VER]', + + // Browser + 'Chrome' => array('Chrome/[VER]', 'CriOS/[VER]', 'CrMo/[VER]'), + 'Coast' => array('Coast/[VER]'), + 'Dolfin' => 'Dolfin/[VER]', + // @reference: https://developer.mozilla.org/en-US/docs/User_Agent_Strings_Reference + 'Firefox' => 'Firefox/[VER]', + 'Fennec' => 'Fennec/[VER]', + // http://msdn.microsoft.com/en-us/library/ms537503(v=vs.85).aspx + // https://msdn.microsoft.com/en-us/library/ie/hh869301(v=vs.85).aspx + 'Edge' => 'Edge/[VER]', + 'IE' => array('IEMobile/[VER];', 'IEMobile [VER]', 'MSIE [VER];', 'Trident/[0-9.]+;.*rv:[VER]'), + // http://en.wikipedia.org/wiki/NetFront + 'NetFront' => 'NetFront/[VER]', + 'NokiaBrowser' => 'NokiaBrowser/[VER]', + 'Opera' => array( ' OPR/[VER]', 'Opera Mini/[VER]', 'Version/[VER]' ), + 'Opera Mini' => 'Opera Mini/[VER]', + 'Opera Mobi' => 'Version/[VER]', + 'UC Browser' => 'UC Browser[VER]', + 'MQQBrowser' => 'MQQBrowser/[VER]', + 'MicroMessenger' => 'MicroMessenger/[VER]', + 'baiduboxapp' => 'baiduboxapp/[VER]', + 'baidubrowser' => 'baidubrowser/[VER]', + 'Iron' => 'Iron/[VER]', + // @note: Safari 7534.48.3 is actually Version 5.1. + // @note: On BlackBerry the Version is overwriten by the OS. + 'Safari' => array( 'Version/[VER]', 'Safari/[VER]' ), + 'Skyfire' => 'Skyfire/[VER]', + 'Tizen' => 'Tizen/[VER]', + 'Webkit' => 'webkit[ /][VER]', + 'PaleMoon' => 'PaleMoon/[VER]', + + // Engine + 'Gecko' => 'Gecko/[VER]', + 'Trident' => 'Trident/[VER]', + 'Presto' => 'Presto/[VER]', + 'Goanna' => 'Goanna/[VER]', + + // OS + 'iOS' => ' \bi?OS\b [VER][ ;]{1}', + 'Android' => 'Android [VER]', + 'BlackBerry' => array('BlackBerry[\w]+/[VER]', 'BlackBerry.*Version/[VER]', 'Version/[VER]'), + 'BREW' => 'BREW [VER]', + 'Java' => 'Java/[VER]', + // @reference: http://windowsteamblog.com/windows_phone/b/wpdev/archive/2011/08/29/introducing-the-ie9-on-windows-phone-mango-user-agent-string.aspx + // @reference: http://en.wikipedia.org/wiki/Windows_NT#Releases + 'Windows Phone OS' => array( 'Windows Phone OS [VER]', 'Windows Phone [VER]'), + 'Windows Phone' => 'Windows Phone [VER]', + 'Windows CE' => 'Windows CE/[VER]', + // http://social.msdn.microsoft.com/Forums/en-US/windowsdeveloperpreviewgeneral/thread/6be392da-4d2f-41b4-8354-8dcee20c85cd + 'Windows NT' => 'Windows NT [VER]', + 'Symbian' => array('SymbianOS/[VER]', 'Symbian/[VER]'), + 'webOS' => array('webOS/[VER]', 'hpwOS/[VER];'), + ); + + /** + * Construct an instance of this class. + * + * @param array $headers Specify the headers as injection. Should be PHP _SERVER flavored. + * If left empty, will use the global _SERVER['HTTP_*'] vars instead. + * @param string $userAgent Inject the User-Agent header. If null, will use HTTP_USER_AGENT + * from the $headers array instead. + */ + public function __construct( + array $headers = null, + $userAgent = null + ) { + $this->setHttpHeaders($headers); + $this->setUserAgent($userAgent); + } + + /** + * Get the current script version. + * This is useful for the demo.php file, + * so people can check on what version they are testing + * for mobile devices. + * + * @return string The version number in semantic version format. + */ + public static function getScriptVersion() + { + return self::VERSION; + } + + /** + * Set the HTTP Headers. Must be PHP-flavored. This method will reset existing headers. + * + * @param array $httpHeaders The headers to set. If null, then using PHP's _SERVER to extract + * the headers. The default null is left for backwards compatibility. + */ + public function setHttpHeaders($httpHeaders = null) + { + // use global _SERVER if $httpHeaders aren't defined + if (!is_array($httpHeaders) || !count($httpHeaders)) { + $httpHeaders = $_SERVER; + } + + // clear existing headers + $this->httpHeaders = array(); + + // Only save HTTP headers. In PHP land, that means only _SERVER vars that + // start with HTTP_. + foreach ($httpHeaders as $key => $value) { + if (substr($key, 0, 5) === 'HTTP_') { + $this->httpHeaders[$key] = $value; + } + } + + // In case we're dealing with CloudFront, we need to know. + $this->setCfHeaders($httpHeaders); + } + + /** + * Retrieves the HTTP headers. + * + * @return array + */ + public function getHttpHeaders() + { + return $this->httpHeaders; + } + + /** + * Retrieves a particular header. If it doesn't exist, no exception/error is caused. + * Simply null is returned. + * + * @param string $header The name of the header to retrieve. Can be HTTP compliant such as + * "User-Agent" or "X-Device-User-Agent" or can be php-esque with the + * all-caps, HTTP_ prefixed, underscore seperated awesomeness. + * + * @return string|null The value of the header. + */ + public function getHttpHeader($header) + { + // are we using PHP-flavored headers? + if (strpos($header, '_') === false) { + $header = str_replace('-', '_', $header); + $header = strtoupper($header); + } + + // test the alternate, too + $altHeader = 'HTTP_' . $header; + + //Test both the regular and the HTTP_ prefix + if (isset($this->httpHeaders[$header])) { + return $this->httpHeaders[$header]; + } elseif (isset($this->httpHeaders[$altHeader])) { + return $this->httpHeaders[$altHeader]; + } + + return null; + } + + public function getMobileHeaders() + { + return self::$mobileHeaders; + } + + /** + * Get all possible HTTP headers that + * can contain the User-Agent string. + * + * @return array List of HTTP headers. + */ + public function getUaHttpHeaders() + { + return self::$uaHttpHeaders; + } + + + /** + * Set CloudFront headers + * http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html#header-caching-web-device + * + * @param array $cfHeaders List of HTTP headers + * + * @return boolean If there were CloudFront headers to be set + */ + public function setCfHeaders($cfHeaders = null) { + // use global _SERVER if $cfHeaders aren't defined + if (!is_array($cfHeaders) || !count($cfHeaders)) { + $cfHeaders = $_SERVER; + } + + // clear existing headers + $this->cloudfrontHeaders = array(); + + // Only save CLOUDFRONT headers. In PHP land, that means only _SERVER vars that + // start with cloudfront-. + $response = false; + foreach ($cfHeaders as $key => $value) { + if (substr(strtolower($key), 0, 16) === 'http_cloudfront_') { + $this->cloudfrontHeaders[strtoupper($key)] = $value; + $response = true; + } + } + + return $response; + } + + /** + * Retrieves the cloudfront headers. + * + * @return array + */ + public function getCfHeaders() + { + return $this->cloudfrontHeaders; + } + + /** + * Set the User-Agent to be used. + * + * @param string $userAgent The user agent string to set. + * + * @return string|null + */ + public function setUserAgent($userAgent = null) + { + // Invalidate cache due to #375 + $this->cache = array(); + + if (false === empty($userAgent)) { + return $this->userAgent = $userAgent; + } else { + $this->userAgent = null; + foreach ($this->getUaHttpHeaders() as $altHeader) { + if (false === empty($this->httpHeaders[$altHeader])) { // @todo: should use getHttpHeader(), but it would be slow. (Serban) + $this->userAgent .= $this->httpHeaders[$altHeader] . " "; + } + } + + if (!empty($this->userAgent)) { + return $this->userAgent = trim($this->userAgent); + } + } + + if (count($this->getCfHeaders()) > 0) { + return $this->userAgent = 'Amazon CloudFront'; + } + return $this->userAgent = null; + } + + /** + * Retrieve the User-Agent. + * + * @return string|null The user agent if it's set. + */ + public function getUserAgent() + { + return $this->userAgent; + } + + /** + * Set the detection type. Must be one of self::DETECTION_TYPE_MOBILE or + * self::DETECTION_TYPE_EXTENDED. Otherwise, nothing is set. + * + * @deprecated since version 2.6.9 + * + * @param string $type The type. Must be a self::DETECTION_TYPE_* constant. The default + * parameter is null which will default to self::DETECTION_TYPE_MOBILE. + */ + public function setDetectionType($type = null) + { + if ($type === null) { + $type = self::DETECTION_TYPE_MOBILE; + } + + if ($type !== self::DETECTION_TYPE_MOBILE && $type !== self::DETECTION_TYPE_EXTENDED) { + return; + } + + $this->detectionType = $type; + } + + public function getMatchingRegex() + { + return $this->matchingRegex; + } + + public function getMatchesArray() + { + return $this->matchesArray; + } + + /** + * Retrieve the list of known phone devices. + * + * @return array List of phone devices. + */ + public static function getPhoneDevices() + { + return self::$phoneDevices; + } + + /** + * Retrieve the list of known tablet devices. + * + * @return array List of tablet devices. + */ + public static function getTabletDevices() + { + return self::$tabletDevices; + } + + /** + * Alias for getBrowsers() method. + * + * @return array List of user agents. + */ + public static function getUserAgents() + { + return self::getBrowsers(); + } + + /** + * Retrieve the list of known browsers. Specifically, the user agents. + * + * @return array List of browsers / user agents. + */ + public static function getBrowsers() + { + return self::$browsers; + } + + /** + * Retrieve the list of known utilities. + * + * @return array List of utilities. + */ + public static function getUtilities() + { + return self::$utilities; + } + + /** + * Method gets the mobile detection rules. This method is used for the magic methods $detect->is*(). + * + * @deprecated since version 2.6.9 + * + * @return array All the rules (but not extended). + */ + public static function getMobileDetectionRules() + { + static $rules; + + if (!$rules) { + $rules = array_merge( + self::$phoneDevices, + self::$tabletDevices, + self::$operatingSystems, + self::$browsers + ); + } + + return $rules; + + } + + /** + * Method gets the mobile detection rules + utilities. + * The reason this is separate is because utilities rules + * don't necessary imply mobile. This method is used inside + * the new $detect->is('stuff') method. + * + * @deprecated since version 2.6.9 + * + * @return array All the rules + extended. + */ + public function getMobileDetectionRulesExtended() + { + static $rules; + + if (!$rules) { + // Merge all rules together. + $rules = array_merge( + self::$phoneDevices, + self::$tabletDevices, + self::$operatingSystems, + self::$browsers, + self::$utilities + ); + } + + return $rules; + } + + /** + * Retrieve the current set of rules. + * + * @deprecated since version 2.6.9 + * + * @return array + */ + public function getRules() + { + if ($this->detectionType == self::DETECTION_TYPE_EXTENDED) { + return self::getMobileDetectionRulesExtended(); + } else { + return self::getMobileDetectionRules(); + } + } + + /** + * Retrieve the list of mobile operating systems. + * + * @return array The list of mobile operating systems. + */ + public static function getOperatingSystems() + { + return self::$operatingSystems; + } + + /** + * Check the HTTP headers for signs of mobile. + * This is the fastest mobile check possible; it's used + * inside isMobile() method. + * + * @return bool + */ + public function checkHttpHeadersForMobile() + { + + foreach ($this->getMobileHeaders() as $mobileHeader => $matchType) { + if (isset($this->httpHeaders[$mobileHeader])) { + if (is_array($matchType['matches'])) { + foreach ($matchType['matches'] as $_match) { + if (strpos($this->httpHeaders[$mobileHeader], $_match) !== false) { + return true; + } + } + + return false; + } else { + return true; + } + } + } + + return false; + + } + + /** + * Magic overloading method. + * + * @method boolean is[...]() + * @param string $name + * @param array $arguments + * @return mixed + * @throws BadMethodCallException when the method doesn't exist and doesn't start with 'is' + */ + public function __call($name, $arguments) + { + // make sure the name starts with 'is', otherwise + if (substr($name, 0, 2) !== 'is') { + throw new BadMethodCallException("No such method exists: $name"); + } + + $this->setDetectionType(self::DETECTION_TYPE_MOBILE); + + $key = substr($name, 2); + + return $this->matchUAAgainstKey($key); + } + + /** + * Find a detection rule that matches the current User-agent. + * + * @param null $userAgent deprecated + * @return boolean + */ + protected function matchDetectionRulesAgainstUA($userAgent = null) + { + // Begin general search. + foreach ($this->getRules() as $_regex) { + if (empty($_regex)) { + continue; + } + + if ($this->match($_regex, $userAgent)) { + return true; + } + } + + return false; + } + + /** + * Search for a certain key in the rules array. + * If the key is found then try to match the corresponding + * regex against the User-Agent. + * + * @param string $key + * + * @return boolean + */ + protected function matchUAAgainstKey($key) + { + // Make the keys lowercase so we can match: isIphone(), isiPhone(), isiphone(), etc. + $key = strtolower($key); + if (false === isset($this->cache[$key])) { + + // change the keys to lower case + $_rules = array_change_key_case($this->getRules()); + + if (false === empty($_rules[$key])) { + $this->cache[$key] = $this->match($_rules[$key]); + } + + if (false === isset($this->cache[$key])) { + $this->cache[$key] = false; + } + } + + return $this->cache[$key]; + } + + /** + * Check if the device is mobile. + * Returns true if any type of mobile device detected, including special ones + * @param null $userAgent deprecated + * @param null $httpHeaders deprecated + * @return bool + */ + public function isMobile($userAgent = null, $httpHeaders = null) + { + + if ($httpHeaders) { + $this->setHttpHeaders($httpHeaders); + } + + if ($userAgent) { + $this->setUserAgent($userAgent); + } + + // Check specifically for cloudfront headers if the useragent === 'Amazon CloudFront' + if ($this->getUserAgent() === 'Amazon CloudFront') { + $cfHeaders = $this->getCfHeaders(); + if(array_key_exists('HTTP_CLOUDFRONT_IS_MOBILE_VIEWER', $cfHeaders) && $cfHeaders['HTTP_CLOUDFRONT_IS_MOBILE_VIEWER'] === 'true') { + return true; + } + } + + $this->setDetectionType(self::DETECTION_TYPE_MOBILE); + + if ($this->checkHttpHeadersForMobile()) { + return true; + } else { + return $this->matchDetectionRulesAgainstUA(); + } + + } + + /** + * Check if the device is a tablet. + * Return true if any type of tablet device is detected. + * + * @param string $userAgent deprecated + * @param array $httpHeaders deprecated + * @return bool + */ + public function isTablet($userAgent = null, $httpHeaders = null) + { + // Check specifically for cloudfront headers if the useragent === 'Amazon CloudFront' + if ($this->getUserAgent() === 'Amazon CloudFront') { + $cfHeaders = $this->getCfHeaders(); + if(array_key_exists('HTTP_CLOUDFRONT_IS_TABLET_VIEWER', $cfHeaders) && $cfHeaders['HTTP_CLOUDFRONT_IS_TABLET_VIEWER'] === 'true') { + return true; + } + } + + $this->setDetectionType(self::DETECTION_TYPE_MOBILE); + + foreach (self::$tabletDevices as $_regex) { + if ($this->match($_regex, $userAgent)) { + return true; + } + } + + return false; + } + + /** + * This method checks for a certain property in the + * userAgent. + * @todo: The httpHeaders part is not yet used. + * + * @param string $key + * @param string $userAgent deprecated + * @param string $httpHeaders deprecated + * @return bool|int|null + */ + public function is($key, $userAgent = null, $httpHeaders = null) + { + // Set the UA and HTTP headers only if needed (eg. batch mode). + if ($httpHeaders) { + $this->setHttpHeaders($httpHeaders); + } + + if ($userAgent) { + $this->setUserAgent($userAgent); + } + + $this->setDetectionType(self::DETECTION_TYPE_EXTENDED); + + return $this->matchUAAgainstKey($key); + } + + /** + * Some detection rules are relative (not standard), + * because of the diversity of devices, vendors and + * their conventions in representing the User-Agent or + * the HTTP headers. + * + * This method will be used to check custom regexes against + * the User-Agent string. + * + * @param $regex + * @param string $userAgent + * @return bool + * + * @todo: search in the HTTP headers too. + */ + public function match($regex, $userAgent = null) + { + $match = (bool) preg_match(sprintf('#%s#is', $regex), (false === empty($userAgent) ? $userAgent : $this->userAgent), $matches); + // If positive match is found, store the results for debug. + if ($match) { + $this->matchingRegex = $regex; + $this->matchesArray = $matches; + } + + return $match; + } + + /** + * Get the properties array. + * + * @return array + */ + public static function getProperties() + { + return self::$properties; + } + + /** + * Prepare the version number. + * + * @todo Remove the error supression from str_replace() call. + * + * @param string $ver The string version, like "2.6.21.2152"; + * + * @return float + */ + public function prepareVersionNo($ver) + { + $ver = str_replace(array('_', ' ', '/'), '.', $ver); + $arrVer = explode('.', $ver, 2); + + if (isset($arrVer[1])) { + $arrVer[1] = @str_replace('.', '', $arrVer[1]); // @todo: treat strings versions. + } + + return (float) implode('.', $arrVer); + } + + /** + * Check the version of the given property in the User-Agent. + * Will return a float number. (eg. 2_0 will return 2.0, 4.3.1 will return 4.31) + * + * @param string $propertyName The name of the property. See self::getProperties() array + * keys for all possible properties. + * @param string $type Either self::VERSION_TYPE_STRING to get a string value or + * self::VERSION_TYPE_FLOAT indicating a float value. This parameter + * is optional and defaults to self::VERSION_TYPE_STRING. Passing an + * invalid parameter will default to the this type as well. + * + * @return string|float The version of the property we are trying to extract. + */ + public function version($propertyName, $type = self::VERSION_TYPE_STRING) + { + if (empty($propertyName)) { + return false; + } + + // set the $type to the default if we don't recognize the type + if ($type !== self::VERSION_TYPE_STRING && $type !== self::VERSION_TYPE_FLOAT) { + $type = self::VERSION_TYPE_STRING; + } + + $properties = self::getProperties(); + + // Check if the property exists in the properties array. + if (true === isset($properties[$propertyName])) { + + // Prepare the pattern to be matched. + // Make sure we always deal with an array (string is converted). + $properties[$propertyName] = (array) $properties[$propertyName]; + + foreach ($properties[$propertyName] as $propertyMatchString) { + + $propertyPattern = str_replace('[VER]', self::VER, $propertyMatchString); + + // Identify and extract the version. + preg_match(sprintf('#%s#is', $propertyPattern), $this->userAgent, $match); + + if (false === empty($match[1])) { + $version = ($type == self::VERSION_TYPE_FLOAT ? $this->prepareVersionNo($match[1]) : $match[1]); + + return $version; + } + + } + + } + + return false; + } + + /** + * Retrieve the mobile grading, using self::MOBILE_GRADE_* constants. + * + * @return string One of the self::MOBILE_GRADE_* constants. + */ + public function mobileGrade() + { + $isMobile = $this->isMobile(); + + if ( + // Apple iOS 4-7.0 – Tested on the original iPad (4.3 / 5.0), iPad 2 (4.3 / 5.1 / 6.1), iPad 3 (5.1 / 6.0), iPad Mini (6.1), iPad Retina (7.0), iPhone 3GS (4.3), iPhone 4 (4.3 / 5.1), iPhone 4S (5.1 / 6.0), iPhone 5 (6.0), and iPhone 5S (7.0) + $this->is('iOS') && $this->version('iPad', self::VERSION_TYPE_FLOAT) >= 4.3 || + $this->is('iOS') && $this->version('iPhone', self::VERSION_TYPE_FLOAT) >= 4.3 || + $this->is('iOS') && $this->version('iPod', self::VERSION_TYPE_FLOAT) >= 4.3 || + + // Android 2.1-2.3 - Tested on the HTC Incredible (2.2), original Droid (2.2), HTC Aria (2.1), Google Nexus S (2.3). Functional on 1.5 & 1.6 but performance may be sluggish, tested on Google G1 (1.5) + // Android 3.1 (Honeycomb) - Tested on the Samsung Galaxy Tab 10.1 and Motorola XOOM + // Android 4.0 (ICS) - Tested on a Galaxy Nexus. Note: transition performance can be poor on upgraded devices + // Android 4.1 (Jelly Bean) - Tested on a Galaxy Nexus and Galaxy 7 + ( $this->version('Android', self::VERSION_TYPE_FLOAT)>2.1 && $this->is('Webkit') ) || + + // Windows Phone 7.5-8 - Tested on the HTC Surround (7.5), HTC Trophy (7.5), LG-E900 (7.5), Nokia 800 (7.8), HTC Mazaa (7.8), Nokia Lumia 520 (8), Nokia Lumia 920 (8), HTC 8x (8) + $this->version('Windows Phone OS', self::VERSION_TYPE_FLOAT) >= 7.5 || + + // Tested on the Torch 9800 (6) and Style 9670 (6), BlackBerry® Torch 9810 (7), BlackBerry Z10 (10) + $this->is('BlackBerry') && $this->version('BlackBerry', self::VERSION_TYPE_FLOAT) >= 6.0 || + // Blackberry Playbook (1.0-2.0) - Tested on PlayBook + $this->match('Playbook.*Tablet') || + + // Palm WebOS (1.4-3.0) - Tested on the Palm Pixi (1.4), Pre (1.4), Pre 2 (2.0), HP TouchPad (3.0) + ( $this->version('webOS', self::VERSION_TYPE_FLOAT) >= 1.4 && $this->match('Palm|Pre|Pixi') ) || + // Palm WebOS 3.0 - Tested on HP TouchPad + $this->match('hp.*TouchPad') || + + // Firefox Mobile 18 - Tested on Android 2.3 and 4.1 devices + ( $this->is('Firefox') && $this->version('Firefox', self::VERSION_TYPE_FLOAT) >= 18 ) || + + // Chrome for Android - Tested on Android 4.0, 4.1 device + ( $this->is('Chrome') && $this->is('AndroidOS') && $this->version('Android', self::VERSION_TYPE_FLOAT) >= 4.0 ) || + + // Skyfire 4.1 - Tested on Android 2.3 device + ( $this->is('Skyfire') && $this->version('Skyfire', self::VERSION_TYPE_FLOAT) >= 4.1 && $this->is('AndroidOS') && $this->version('Android', self::VERSION_TYPE_FLOAT) >= 2.3 ) || + + // Opera Mobile 11.5-12: Tested on Android 2.3 + ( $this->is('Opera') && $this->version('Opera Mobi', self::VERSION_TYPE_FLOAT) >= 11.5 && $this->is('AndroidOS') ) || + + // Meego 1.2 - Tested on Nokia 950 and N9 + $this->is('MeeGoOS') || + + // Tizen (pre-release) - Tested on early hardware + $this->is('Tizen') || + + // Samsung Bada 2.0 - Tested on a Samsung Wave 3, Dolphin browser + // @todo: more tests here! + $this->is('Dolfin') && $this->version('Bada', self::VERSION_TYPE_FLOAT) >= 2.0 || + + // UC Browser - Tested on Android 2.3 device + ( ($this->is('UC Browser') || $this->is('Dolfin')) && $this->version('Android', self::VERSION_TYPE_FLOAT) >= 2.3 ) || + + // Kindle 3 and Fire - Tested on the built-in WebKit browser for each + ( $this->match('Kindle Fire') || + $this->is('Kindle') && $this->version('Kindle', self::VERSION_TYPE_FLOAT) >= 3.0 ) || + + // Nook Color 1.4.1 - Tested on original Nook Color, not Nook Tablet + $this->is('AndroidOS') && $this->is('NookTablet') || + + // Chrome Desktop 16-24 - Tested on OS X 10.7 and Windows 7 + $this->version('Chrome', self::VERSION_TYPE_FLOAT) >= 16 && !$isMobile || + + // Safari Desktop 5-6 - Tested on OS X 10.7 and Windows 7 + $this->version('Safari', self::VERSION_TYPE_FLOAT) >= 5.0 && !$isMobile || + + // Firefox Desktop 10-18 - Tested on OS X 10.7 and Windows 7 + $this->version('Firefox', self::VERSION_TYPE_FLOAT) >= 10.0 && !$isMobile || + + // Internet Explorer 7-9 - Tested on Windows XP, Vista and 7 + $this->version('IE', self::VERSION_TYPE_FLOAT) >= 7.0 && !$isMobile || + + // Opera Desktop 10-12 - Tested on OS X 10.7 and Windows 7 + $this->version('Opera', self::VERSION_TYPE_FLOAT) >= 10 && !$isMobile + ){ + return self::MOBILE_GRADE_A; + } + + if ( + $this->is('iOS') && $this->version('iPad', self::VERSION_TYPE_FLOAT)<4.3 || + $this->is('iOS') && $this->version('iPhone', self::VERSION_TYPE_FLOAT)<4.3 || + $this->is('iOS') && $this->version('iPod', self::VERSION_TYPE_FLOAT)<4.3 || + + // Blackberry 5.0: Tested on the Storm 2 9550, Bold 9770 + $this->is('Blackberry') && $this->version('BlackBerry', self::VERSION_TYPE_FLOAT) >= 5 && $this->version('BlackBerry', self::VERSION_TYPE_FLOAT)<6 || + + //Opera Mini (5.0-6.5) - Tested on iOS 3.2/4.3 and Android 2.3 + ($this->version('Opera Mini', self::VERSION_TYPE_FLOAT) >= 5.0 && $this->version('Opera Mini', self::VERSION_TYPE_FLOAT) <= 7.0 && + ($this->version('Android', self::VERSION_TYPE_FLOAT) >= 2.3 || $this->is('iOS')) ) || + + // Nokia Symbian^3 - Tested on Nokia N8 (Symbian^3), C7 (Symbian^3), also works on N97 (Symbian^1) + $this->match('NokiaN8|NokiaC7|N97.*Series60|Symbian/3') || + + // @todo: report this (tested on Nokia N71) + $this->version('Opera Mobi', self::VERSION_TYPE_FLOAT) >= 11 && $this->is('SymbianOS') + ){ + return self::MOBILE_GRADE_B; + } + + if ( + // Blackberry 4.x - Tested on the Curve 8330 + $this->version('BlackBerry', self::VERSION_TYPE_FLOAT) <= 5.0 || + // Windows Mobile - Tested on the HTC Leo (WinMo 5.2) + $this->match('MSIEMobile|Windows CE.*Mobile') || $this->version('Windows Mobile', self::VERSION_TYPE_FLOAT) <= 5.2 || + + // Tested on original iPhone (3.1), iPhone 3 (3.2) + $this->is('iOS') && $this->version('iPad', self::VERSION_TYPE_FLOAT) <= 3.2 || + $this->is('iOS') && $this->version('iPhone', self::VERSION_TYPE_FLOAT) <= 3.2 || + $this->is('iOS') && $this->version('iPod', self::VERSION_TYPE_FLOAT) <= 3.2 || + + // Internet Explorer 7 and older - Tested on Windows XP + $this->version('IE', self::VERSION_TYPE_FLOAT) <= 7.0 && !$isMobile + ){ + return self::MOBILE_GRADE_C; + } + + // All older smartphone platforms and featurephones - Any device that doesn't support media queries + // will receive the basic, C grade experience. + return self::MOBILE_GRADE_C; + } +} +endif; \ No newline at end of file diff --git a/wp-ffpc-acache.php b/wp-ffpc-acache.php index 8f8534c..8c36335 100644 --- a/wp-ffpc-acache.php +++ b/wp-ffpc-acache.php @@ -145,7 +145,18 @@ if ( $wp_ffpc_backend->status() === false ) { } /* try to get data & meta keys for current page */ -$wp_ffpc_keys = array ( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data'] ); + +/* include the mobile detect */ +include_once ('backends/mobile-detect.php'); +$mobile_detect = new Mobile_Detect; + +/* verify if mobile device (phones or tablets). */ +if ($mobile_detect->isMobile() ) { + $wp_ffpc_keys = array ( 'meta' => $wp_ffpc_config['prefix_meta']. 'mobile_', 'data' => $wp_ffpc_config['prefix_data']. 'mobile_' ); +} else { + $wp_ffpc_keys = array ( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data']); +} + $wp_ffpc_values = array(); __wp_ffpc_debug__ ( "Trying to fetch entries"); @@ -457,11 +468,16 @@ function wp_ffpc_callback( $buffer ) { /* add generation info is option is set, but only to HTML */ if ( $wp_ffpc_config['generate_time'] == '1' && stripos($buffer, '') ) { - global $wp_ffpc_gentime; + global $wp_ffpc_gentime, + $mobile_detect; + + /* verify the device type to output into the generation stats */ + $device_type = $mobile_detect -> isMobile() ? 'mobile': 'desktop'; + $mtime = explode ( " ", microtime() ); $wp_ffpc_gentime = ( $mtime[1] + $mtime[0] )- $wp_ffpc_gentime; - $insertion = "\n\n"; + $insertion = "\n\n"; $index = stripos( $buffer , '' ); $to_store = substr_replace( $buffer, $insertion, $index, 0); -- 2.46.2 From 510dd9ea2507cf73d36cb7ccc8987ecd3e6a3b79 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 13:04:19 +0100 Subject: [PATCH 3/8] Change the meta conditional and add to the panel --- wp-ffpc-acache.php | 18 ++++++++---------- wp-ffpc-class.php | 16 ++++++++++++++++ 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/wp-ffpc-acache.php b/wp-ffpc-acache.php index 8c36335..c07c004 100644 --- a/wp-ffpc-acache.php +++ b/wp-ffpc-acache.php @@ -149,13 +149,10 @@ if ( $wp_ffpc_backend->status() === false ) { /* include the mobile detect */ include_once ('backends/mobile-detect.php'); $mobile_detect = new Mobile_Detect; - /* verify if mobile device (phones or tablets). */ -if ($mobile_detect->isMobile() ) { - $wp_ffpc_keys = array ( 'meta' => $wp_ffpc_config['prefix_meta']. 'mobile_', 'data' => $wp_ffpc_config['prefix_data']. 'mobile_' ); -} else { - $wp_ffpc_keys = array ( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data']); -} +$wp_ffpc_keys = ($mobile_detect->isMobile() ? + array ( 'meta' => $wp_ffpc_config['prefix_meta_mobile'], 'data' => $wp_ffpc_config['prefix_data_mobile'] ) : + array ( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data']); $wp_ffpc_values = array(); @@ -320,6 +317,8 @@ function wp_ffpc_callback( $buffer ) { global $wp_ffpc_backend; /* check is it's a redirect */ global $wp_ffpc_redirect; + /* check is it's a mobile version*/ + global $mobile_detect; /* no is_home = error, WordPress functions are not availabe */ if (!function_exists('is_home')) @@ -468,8 +467,7 @@ function wp_ffpc_callback( $buffer ) { /* add generation info is option is set, but only to HTML */ if ( $wp_ffpc_config['generate_time'] == '1' && stripos($buffer, '') ) { - global $wp_ffpc_gentime, - $mobile_detect; + global $wp_ffpc_gentime; /* verify the device type to output into the generation stats */ $device_type = $mobile_detect -> isMobile() ? 'mobile': 'desktop'; @@ -496,10 +494,10 @@ function wp_ffpc_callback( $buffer ) { */ $to_store = apply_filters( 'wp-ffpc-to-store', $to_store ); - $prefix_meta = $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_meta'] ); + $prefix_meta = ($mobile_detect -> isMobile())? $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_meta_mobile'] ): $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_meta'] ); $wp_ffpc_backend->set ( $prefix_meta, $meta ); - $prefix_data = $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_data'] ); + $prefix_data = ($mobile_detect -> isMobile())? $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_data_mobile'] ): $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_data'] ); $wp_ffpc_backend->set ( $prefix_data , $to_store ); if ( !empty( $meta['status'] ) && $meta['status'] == 404 ) { diff --git a/wp-ffpc-class.php b/wp-ffpc-class.php index 1c3b40c..4c13205 100644 --- a/wp-ffpc-class.php +++ b/wp-ffpc-class.php @@ -617,6 +617,14 @@ class WP_FFPC extends WP_FFPC_ABSTRACT { WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> +
+ +
+
+ + WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> +
+
@@ -625,6 +633,14 @@ class WP_FFPC extends WP_FFPC_ABSTRACT { WARNING: changing this will result the previous cache to becomes invalid!', 'wp-ffpc'); ?> +
+ +
+
+ + WARNING: changing this will result the previous cache to becomes invalid!', 'wp-ffpc'); ?> +
+
-- 2.46.2 From 75a36cb04010d532c71993bebd7a6460fcd78280 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 13:07:46 +0100 Subject: [PATCH 4/8] Add meda and data mobile default values --- wp-ffpc-class.php | 4 ++-- wp-ffpc.php | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/wp-ffpc-class.php b/wp-ffpc-class.php index 4c13205..7cf4bc4 100644 --- a/wp-ffpc-class.php +++ b/wp-ffpc-class.php @@ -618,7 +618,7 @@ class WP_FFPC extends WP_FFPC_ABSTRACT {
- +
@@ -634,7 +634,7 @@ class WP_FFPC extends WP_FFPC_ABSTRACT {
- +
diff --git a/wp-ffpc.php b/wp-ffpc.php index 64f3a40..bd8db82 100644 --- a/wp-ffpc.php +++ b/wp-ffpc.php @@ -44,7 +44,9 @@ $wp_ffpc_defaults = array ( 'expire_taxonomy' => 300, 'invalidation_method' => 0, 'prefix_meta' => 'meta-', + 'prefix_meta_mobile' => 'meta-mobile-', 'prefix_data' => 'data-', + 'prefix_data_mobile' => 'data-mobile-', 'charset' => 'utf-8', 'log' => true, 'cache_type' => 'memcached', @@ -69,4 +71,4 @@ $wp_ffpc_defaults = array ( 'hashkey' => false, ); -$wp_ffpc = new WP_FFPC ( 'wp-ffpc', '1.11.2', 'WP-FFPC', $wp_ffpc_defaults, 'PeterMolnar_WordPressPlugins_wp-ffpc_HU' , 'WP-FFPC' , 'FA3NT7XDVHPWU' ); +$wp_ffpc = new WP_FFPC ( 'wp-ffpc', '1.12.0', 'WP-FFPC', $wp_ffpc_defaults, 'PeterMolnar_WordPressPlugins_wp-ffpc_HU' , 'WP-FFPC' , 'FA3NT7XDVHPWU' ); -- 2.46.2 From 80776814785f3adc53c526b4eccbc28f29d58324 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 13:10:08 +0100 Subject: [PATCH 5/8] Fix the dt close tag --- wp-ffpc-acache.php | 2 +- wp-ffpc-class.php | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/wp-ffpc-acache.php b/wp-ffpc-acache.php index c07c004..4f6d2d9 100644 --- a/wp-ffpc-acache.php +++ b/wp-ffpc-acache.php @@ -150,7 +150,7 @@ if ( $wp_ffpc_backend->status() === false ) { include_once ('backends/mobile-detect.php'); $mobile_detect = new Mobile_Detect; /* verify if mobile device (phones or tablets). */ -$wp_ffpc_keys = ($mobile_detect->isMobile() ? +$wp_ffpc_keys = $mobile_detect->isMobile() ? array ( 'meta' => $wp_ffpc_config['prefix_meta_mobile'], 'data' => $wp_ffpc_config['prefix_data_mobile'] ) : array ( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data']); diff --git a/wp-ffpc-class.php b/wp-ffpc-class.php index 7cf4bc4..d664eda 100644 --- a/wp-ffpc-class.php +++ b/wp-ffpc-class.php @@ -713,7 +713,8 @@ class WP_FFPC extends WP_FFPC_ABSTRACT {
- + +
-- 2.46.2 From 5d9530e3ae6abacff30c14f5f8d3ac5802529873 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 13:18:09 +0100 Subject: [PATCH 6/8] Add readme update --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a4310d7..04aaae9 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ Many thanks for donations, contributors, supporters, testers & bug reporters: * 7th Veil, LLC * Julia Harsch * Grant Berntsen +* [Glaydston Veloso](https://github.com/glaydston) == Installation == -- 2.46.2 From 65b7f20ed2fce55062492a41f02444d19442cf61 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 13:29:04 +0100 Subject: [PATCH 7/8] Fix some returns --- wp-ffpc-abstract.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/wp-ffpc-abstract.php b/wp-ffpc-abstract.php index b6dfcc0..7f67190 100644 --- a/wp-ffpc-abstract.php +++ b/wp-ffpc-abstract.php @@ -227,7 +227,7 @@ abstract class WP_FFPC_ABSTRACT { * callback function to add settings link to plugins page * * @param array $links Current links to add ours to - * + * @return array $links Current links */ public function plugin_settings_link ( $links ) { $settings_link = '' . __translate__( 'Settings', 'wp-ffpc') . ''; @@ -359,7 +359,7 @@ abstract class WP_FFPC_ABSTRACT { * * @param mixed $var Variable to dump * @param boolean $ret Return text instead of printing if true - * + * @return mixed $var Variable to dump */ protected function print_var ( $var , $ret = false ) { if ( @is_array ( $var ) || @is_object( $var ) || @is_bool( $var ) ) @@ -401,7 +401,7 @@ abstract class WP_FFPC_ABSTRACT { * @param $print * boolean: is true, the options will be printed, otherwise the string will be returned * - * @return + * @return mixed * prints or returns the options string * */ @@ -594,9 +594,9 @@ abstract class WP_FFPC_ABSTRACT { * display formatted alert message * * @param string $msg Error message - * @param string $error "level" of error + * @param mixed $level "level" of error * @param boolean $network WordPress network or not, DEPRECATED - * + * @return mixed */ static public function alert ( $msg, $level=LOG_WARNING, $network=false ) { if ( empty($msg)) return false; -- 2.46.2 From cd968726fb8e84f00da3fc542914a00dba6860c3 Mon Sep 17 00:00:00 2001 From: Glaydston Veloso Date: Wed, 9 Nov 2016 18:22:15 +0100 Subject: [PATCH 8/8] Add logs to the mobile detect --- wp-ffpc-acache.php | 25 +- wp-ffpc-class.php | 2388 ++++++++++++++++++++++---------------------- wp-ffpc.php | 6 +- 3 files changed, 1213 insertions(+), 1206 deletions(-) diff --git a/wp-ffpc-acache.php b/wp-ffpc-acache.php index 4f6d2d9..536a536 100644 --- a/wp-ffpc-acache.php +++ b/wp-ffpc-acache.php @@ -70,7 +70,7 @@ else { } /* no cache for WooCommerce URL patterns */ -if ( isset($wp_ffpc_config['nocache_woocommerce']) && !empty($wp_ffpc_config['nocache_woocommerce']) && +if ( isset($wp_ffpc_config['nocache_woocommerce']) && !empty($wp_ffpc_config['nocache_woocommerce']) && isset($wp_ffpc_config['nocache_woocommerce_url']) && trim($wp_ffpc_config['nocache_woocommerce_url']) ) { $pattern = sprintf('#%s#', trim($wp_ffpc_config['nocache_woocommerce_url'])); if ( preg_match($pattern, $wp_ffpc_uri) ) { @@ -149,10 +149,16 @@ if ( $wp_ffpc_backend->status() === false ) { /* include the mobile detect */ include_once ('backends/mobile-detect.php'); $mobile_detect = new Mobile_Detect; +$wp_ffpc_keys = array(); + /* verify if mobile device (phones or tablets). */ -$wp_ffpc_keys = $mobile_detect->isMobile() ? - array ( 'meta' => $wp_ffpc_config['prefix_meta_mobile'], 'data' => $wp_ffpc_config['prefix_data_mobile'] ) : - array ( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data']); +if($mobile_detect->isMobile()){ + __wp_ffpc_debug__('Set the ffpc keys to the mobile version'); + $wp_ffpc_keys = array ( 'meta' => $wp_ffpc_config['prefix_meta_mobile'], 'data' => $wp_ffpc_config['prefix_data_mobile'] ); +} else { + __wp_ffpc_debug__('Set the ffpc keys to the desktop version'); + $wp_ffpc_keys = array( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data'] ); +} $wp_ffpc_values = array(); @@ -267,7 +273,7 @@ if ( isset($wp_ffpc_config['generate_time']) && $wp_ffpc_config['generate_time'] $mtime = explode ( " ", microtime() ); $wp_ffpc_gentime = ( $mtime[1] + $mtime[0] ) - $wp_ffpc_gentime; - $insertion = "\n\n"; + $insertion = "\n\n"; $index = stripos( $wp_ffpc_values['data'] , '' ); $wp_ffpc_values['data'] = substr_replace( $wp_ffpc_values['data'], $insertion, $index, 0); @@ -317,8 +323,8 @@ function wp_ffpc_callback( $buffer ) { global $wp_ffpc_backend; /* check is it's a redirect */ global $wp_ffpc_redirect; - /* check is it's a mobile version*/ - global $mobile_detect; + /* check is it's a mobile version*/ + global $mobile_detect; /* no is_home = error, WordPress functions are not availabe */ if (!function_exists('is_home')) @@ -469,8 +475,9 @@ function wp_ffpc_callback( $buffer ) { if ( $wp_ffpc_config['generate_time'] == '1' && stripos($buffer, '') ) { global $wp_ffpc_gentime; - /* verify the device type to output into the generation stats */ - $device_type = $mobile_detect -> isMobile() ? 'mobile': 'desktop'; + /* verify the device type to output into the generation stats */ + $device_type = $mobile_detect -> isMobile() ? 'mobile': 'desktop'; + __wp_ffpc_debug__('The device type is: ' . $device_type); $mtime = explode ( " ", microtime() ); $wp_ffpc_gentime = ( $mtime[1] + $mtime[0] )- $wp_ffpc_gentime; diff --git a/wp-ffpc-class.php b/wp-ffpc-class.php index d664eda..4ff2cfd 100644 --- a/wp-ffpc-class.php +++ b/wp-ffpc-class.php @@ -4,1217 +4,1217 @@ defined('ABSPATH') or die("Walk away."); if ( ! class_exists( 'WP_FFPC' ) ) : -/* get the plugin abstract class*/ -include_once ( dirname(__FILE__) . '/wp-ffpc-abstract.php' ); -/* get the common functions class*/ -include_once ( dirname(__FILE__) .'/wp-ffpc-backend.php' ); - -/** - * main wp-ffpc class - * - * @var string $acache_worker advanced cache "worker" file, bundled with the plugin - * @var string $acache WordPress advanced-cache.php file location - * @var string $nginx_sample nginx sample config file, bundled with the plugin - * @var string $acache_backend backend driver file, bundled with the plugin - * @var string $button_flush flush button identifier - * @var string $button_precache precache button identifier - * @var string $global_option global options identifier - * @var string $precache_logfile Precache log file location - * @var string $precache_phpfile Precache PHP worker location - * @var array $shell_possibilities List of possible precache worker callers - [TODO] finish list of vars - */ -class WP_FFPC extends WP_FFPC_ABSTRACT { - const host_separator = ','; - const port_separator = ':'; - const donation_id_key = 'hosted_button_id='; - const global_config_var = '$wp_ffpc_config'; - const key_save = 'saved'; - const key_delete = 'deleted'; - const key_flush = 'flushed'; - const slug_flush = '&flushed=true'; - const key_precache = 'precached'; - const slug_precache = '&precached=true'; - const key_precache_disabled = 'precache_disabled'; - const slug_precache_disabled = '&precache_disabled=true'; - const precache_log = 'wp-ffpc-precache-log'; - const precache_timestamp = 'wp-ffpc-precache-timestamp'; - const precache_php = 'wp-ffpc-precache.php'; - const precache_id = 'wp-ffpc-precache-task'; - private $precache_message = ''; - private $precache_logfile = ''; - private $precache_phpfile = ''; - private $global_option = ''; - private $global_config_key = ''; - private $global_config = array(); - private $global_saved = false; - private $acache_worker = ''; - private $acache = ''; - private $nginx_sample = ''; - private $acache_backend = ''; - private $button_flush; - private $button_precache; - private $select_cache_type = array (); - private $select_invalidation_method = array (); - private $select_schedules = array(); - private $valid_cache_type = array (); - private $list_uri_vars = array(); - private $shell_function = false; - private $shell_possibilities = array (); - private $backend = NULL; - private $scheduled = false; - private $errors = array(); + /* get the plugin abstract class*/ + include_once ( dirname(__FILE__) . '/wp-ffpc-abstract.php' ); + /* get the common functions class*/ + include_once ( dirname(__FILE__) .'/wp-ffpc-backend.php' ); /** + * main wp-ffpc class * + * @var string $acache_worker advanced cache "worker" file, bundled with the plugin + * @var string $acache WordPress advanced-cache.php file location + * @var string $nginx_sample nginx sample config file, bundled with the plugin + * @var string $acache_backend backend driver file, bundled with the plugin + * @var string $button_flush flush button identifier + * @var string $button_precache precache button identifier + * @var string $global_option global options identifier + * @var string $precache_logfile Precache log file location + * @var string $precache_phpfile Precache PHP worker location + * @var array $shell_possibilities List of possible precache worker callers + [TODO] finish list of vars */ - public function plugin_post_construct () { - static::debug ( __CLASS__, 'post_construct' ); - $this->plugin_url = plugin_dir_url( __FILE__ ); - $this->plugin_dir = plugin_dir_path( __FILE__ ); + class WP_FFPC extends WP_FFPC_ABSTRACT { + const host_separator = ','; + const port_separator = ':'; + const donation_id_key = 'hosted_button_id='; + const global_config_var = '$wp_ffpc_config'; + const key_save = 'saved'; + const key_delete = 'deleted'; + const key_flush = 'flushed'; + const slug_flush = '&flushed=true'; + const key_precache = 'precached'; + const slug_precache = '&precached=true'; + const key_precache_disabled = 'precache_disabled'; + const slug_precache_disabled = '&precache_disabled=true'; + const precache_log = 'wp-ffpc-precache-log'; + const precache_timestamp = 'wp-ffpc-precache-timestamp'; + const precache_php = 'wp-ffpc-precache.php'; + const precache_id = 'wp-ffpc-precache-task'; + private $precache_message = ''; + private $precache_logfile = ''; + private $precache_phpfile = ''; + private $global_option = ''; + private $global_config_key = ''; + private $global_config = array(); + private $global_saved = false; + private $acache_worker = ''; + private $acache = ''; + private $nginx_sample = ''; + private $acache_backend = ''; + private $button_flush; + private $button_precache; + private $select_cache_type = array (); + private $select_invalidation_method = array (); + private $select_schedules = array(); + private $valid_cache_type = array (); + private $list_uri_vars = array(); + private $shell_function = false; + private $shell_possibilities = array (); + private $backend = NULL; + private $scheduled = false; + private $errors = array(); - $this->admin_css_handle = $this->plugin_constant . '-admin-css'; - $this->admin_css_url = $this->plugin_url . 'wp-admin.css'; - } + /** + * + */ + public function plugin_post_construct () { + static::debug ( __CLASS__, 'post_construct' ); + $this->plugin_url = plugin_dir_url( __FILE__ ); + $this->plugin_dir = plugin_dir_path( __FILE__ ); - /** - * init hook function runs before admin panel hook, themeing and options read - */ - public function plugin_pre_init() { - static::debug ( __CLASS__, 'pre_init' ); - /* advanced cache "worker" file */ - $this->acache_worker = $this->plugin_dir . $this->plugin_constant . '-acache.php'; - /* WordPress advanced-cache.php file location */ - $this->acache = WP_CONTENT_DIR . '/advanced-cache.php'; - /* nginx sample config file */ - $this->nginx_sample = $this->plugin_dir . $this->plugin_constant . '-nginx-sample.conf'; - /* backend driver file */ - $this->acache_backend = $this->plugin_dir . $this->plugin_constant . '-engine.php'; - /* flush button identifier */ - $this->button_flush = $this->plugin_constant . '-flush'; - /* precache button identifier */ - $this->button_precache = $this->plugin_constant . '-precache'; - /* global options identifier */ - $this->global_option = $this->plugin_constant . '-global'; - /* precache log */ - $this->precache_logfile = sys_get_temp_dir() . '/' . self::precache_log; - /* this is the precacher php worker file */ - $this->precache_phpfile = sys_get_temp_dir() . '/' . self::precache_php; - /* search for a system function */ - $this->shell_possibilities = array ( 'shell_exec', 'exec', 'system', 'passthru' ); - /* get disabled functions list */ - $disabled_functions = array_map('trim', explode(',', ini_get('disable_functions') ) ); - - foreach ( $this->shell_possibilities as $possible ) { - if ( function_exists ($possible) && ! ( ini_get('safe_mode') || in_array( $possible, $disabled_functions ) ) ) { - /* set shell function */ - $this->shell_function = $possible; - break; - } + $this->admin_css_handle = $this->plugin_constant . '-admin-css'; + $this->admin_css_url = $this->plugin_url . 'wp-admin.css'; } - if (!isset($_SERVER['HTTP_HOST'])) - $_SERVER['HTTP_HOST'] = '127.0.0.1'; + /** + * init hook function runs before admin panel hook, themeing and options read + */ + public function plugin_pre_init() { + static::debug ( __CLASS__, 'pre_init' ); + /* advanced cache "worker" file */ + $this->acache_worker = $this->plugin_dir . $this->plugin_constant . '-acache.php'; + /* WordPress advanced-cache.php file location */ + $this->acache = WP_CONTENT_DIR . '/advanced-cache.php'; + /* nginx sample config file */ + $this->nginx_sample = $this->plugin_dir . $this->plugin_constant . '-nginx-sample.conf'; + /* backend driver file */ + $this->acache_backend = $this->plugin_dir . $this->plugin_constant . '-engine.php'; + /* flush button identifier */ + $this->button_flush = $this->plugin_constant . '-flush'; + /* precache button identifier */ + $this->button_precache = $this->plugin_constant . '-precache'; + /* global options identifier */ + $this->global_option = $this->plugin_constant . '-global'; + /* precache log */ + $this->precache_logfile = sys_get_temp_dir() . '/' . self::precache_log; + /* this is the precacher php worker file */ + $this->precache_phpfile = sys_get_temp_dir() . '/' . self::precache_php; + /* search for a system function */ + $this->shell_possibilities = array ( 'shell_exec', 'exec', 'system', 'passthru' ); + /* get disabled functions list */ + $disabled_functions = array_map('trim', explode(',', ini_get('disable_functions') ) ); - /* set global config key; here, because it's needed for migration */ - if ( $this->network ) { - $this->global_config_key = 'network'; - } - else { - $sitedomain = parse_url( get_option('siteurl') , PHP_URL_HOST); - if ( $_SERVER['HTTP_HOST'] != $sitedomain ) { - $this->errors['domain_mismatch'] = sprintf( __("Domain mismatch: the site domain configuration (%s) does not match the HTTP_HOST (%s) variable in PHP. Please fix the incorrect one, otherwise the plugin may not work as expected.", 'wp-ffpc'), $sitedomain, $_SERVER['HTTP_HOST'] ); - } - - $this->global_config_key = $_SERVER['HTTP_HOST']; - } - - /* cache type possible values array */ - $this->select_cache_type = array ( - 'apc' => __( 'APC' , 'wp-ffpc'), - 'apcu' => __( 'APCu' , 'wp-ffpc'), - 'memcache' => __( 'PHP Memcache' , 'wp-ffpc'), - 'memcached' => __( 'PHP Memcached' , 'wp-ffpc'), - 'redis' => __( 'Redis (experimental, it will break!)' , 'wp-ffpc'), - ); - /* check for required functions / classes for the cache types */ - - $this->valid_cache_type = array ( - 'apc' => (function_exists( 'apc_cache_info' ) && version_compare(PHP_VERSION, '5.3.0') <= 0 ) ? true : false, - 'apcu' => function_exists( 'apcu_cache_info' ) ? true : false, - 'memcache' => class_exists ( 'Memcache') ? true : false, - 'memcached' => class_exists ( 'Memcached') ? true : false, - 'redis' => class_exists( 'Redis' ) ? true : false, - ); - - /* invalidation method possible values array */ - $this->select_invalidation_method = array ( - 0 => __( 'flush cache' , 'wp-ffpc'), - 1 => __( 'only modified post' , 'wp-ffpc'), - 2 => __( 'modified post and all related taxonomies' , 'wp-ffpc'), - ); - - /* map of possible key masks */ - $this->list_uri_vars = array ( - '$scheme' => __('The HTTP scheme (i.e. http, https).', 'wp-ffpc'), - '$host' => __('Host in the header of request or name of the server processing the request if the Host header is not available.', 'wp-ffpc'), - '$request_uri' => __('The *original* request URI as received from the client including the args', 'wp-ffpc'), - '$remote_user' => __('Name of user, authenticated by the Auth Basic Module', 'wp-ffpc'), - '$cookie_PHPSESSID' => __('PHP Session Cookie ID, if set ( empty if not )', 'wp-ffpc'), - '$accept_lang' => __('First HTTP Accept Lang set in the HTTP request', 'wp-ffpc'), - //'$cookie_COOKnginy IE' => __('Value of COOKIE', 'wp-ffpc'), - //'$http_HEADER' => __('Value of HTTP request header HEADER ( lowercase, dashes converted to underscore )', 'wp-ffpc'), - //'$query_string' => __('Full request URI after rewrites', 'wp-ffpc'), - //'' => __('', 'wp-ffpc'), - ); - - /* get current wp_cron schedules */ - $wp_schedules = wp_get_schedules(); - /* add 'null' to switch off timed precache */ - $schedules['null'] = __( 'do not use timed precache' ); - foreach ( $wp_schedules as $interval=>$details ) { - $schedules[ $interval ] = $details['display']; - } - $this->select_schedules = $schedules; - - } - - /** - * additional init, steps that needs the plugin options - * - */ - public function plugin_post_init () { - - /* initiate backend */ - $backend_class = 'WP_FFPC_Backend_' . $this->options['cache_type']; - $this->backend = new $backend_class ( $this->options ); - - /* re-save settings after update */ - add_action( 'upgrader_process_complete', array ( &$this->plugin_upgrade ), 10, 2 ); - - /* cache invalidation hooks */ - add_action( 'transition_post_status', array( &$this->backend , 'clear_ng' ), 10, 3 ); - - /* comments invalidation hooks */ - if ( $this->options['comments_invalidate'] ) { - add_action( 'comment_post', array( &$this->backend , 'clear' ), 0 ); - add_action( 'edit_comment', array( &$this->backend , 'clear' ), 0 ); - add_action( 'trashed_comment', array( &$this->backend , 'clear' ), 0 ); - add_action( 'pingback_post', array( &$this->backend , 'clear' ), 0 ); - add_action( 'trackback_post', array( &$this->backend , 'clear' ), 0 ); - add_action( 'wp_insert_comment', array( &$this->backend , 'clear' ), 0 ); - } - - /* invalidation on some other ocasions as well */ - add_action( 'switch_theme', array( &$this->backend , 'clear' ), 0 ); - add_action( 'deleted_post', array( &$this->backend , 'clear' ), 0 ); - add_action( 'edit_post', array( &$this->backend , 'clear' ), 0 ); - - /* add filter for catching canonical redirects */ - if ( WP_CACHE ) - add_filter('redirect_canonical', 'wp_ffpc_redirect_callback', 10, 2); - - /* add precache coldrun action */ - add_action( self::precache_id , array( &$this, 'precache_coldrun' ) ); - - /* link on to settings for plugins page */ - $settings_link = ' » ' . __( 'WP-FFPC Settings', 'wp-ffpc') . ''; - - /* check & collect errors */ - /* look for WP_CACHE */ - if ( ! WP_CACHE ) - $this->errors['no_wp_cache'] = __("WP_CACHE is disabled. Without that, cache plugins, like this, will not work. Please add `define ( 'WP_CACHE', true );` to the beginning of wp-config.php.", 'wp-ffpc'); - - /* look for global settings array */ - if ( ! $this->global_saved ) - $this->errors['no_global_saved'] = sprintf( __('This site was reached as %s ( according to PHP HTTP_HOST ) and there are no settings present for this domain in the WP-FFPC configuration yet. Please save the %s for the domain or fix the webserver configuration!', 'wp-ffpc'), $_SERVER['HTTP_HOST'], $settings_link); - - /* look for writable acache file */ - if ( file_exists ( $this->acache ) && ! is_writable ( $this->acache ) ) - $this->errors['no_acache_write'] = sprintf(__('Advanced cache file (%s) is not writeable!
Please change the permissions on the file.', 'wp-ffpc'), $this->acache); - - /* look for acache file */ - if ( ! file_exists ( $this->acache ) ) - $this->errors['no_acache_saved'] = sprintf (__('Advanced cache file is yet to be generated, please save %s', 'wp-ffpc'), $settings_link ); - - /* look for extensions that should be available */ - foreach ( $this->valid_cache_type as $backend => $status ) { - if ( $this->options['cache_type'] == $backend && ! $status ) { - $this->errors['no_backend'] = sprintf ( __('%s cache backend activated but no PHP %s extension was found.
Please either use different backend or activate the module!', 'wp-ffpc'), $backend, $backend ); - } - } - - /* get the current runtime configuration for memcache in PHP because Memcache in binary mode is really problematic */ - if ( extension_loaded ( 'memcache' ) ) { - $memcache_settings = ini_get_all( 'memcache' ); - if ( !empty ( $memcache_settings ) && $this->options['cache_type'] == 'memcache' && isset($memcache_settings['memcache.protocol']) ) - { - $memcache_protocol = strtolower($memcache_settings['memcache.protocol']['local_value']); - if ( $memcache_protocol == 'binary' ) { - $this->errors['memcached_binary'] = __('WARNING: Memcache extension is configured to use binary mode. This is very buggy and the plugin will most probably not work correctly.
Please consider to change either to ASCII mode or to Memcached extension.', 'wp-ffpc'); + foreach ( $this->shell_possibilities as $possible ) { + if ( function_exists ($possible) && ! ( ini_get('safe_mode') || in_array( $possible, $disabled_functions ) ) ) { + /* set shell function */ + $this->shell_function = $possible; + break; } } - } - $filtered_errors = apply_filters('wp_ffpc_post_init_errors_array', $this->errors); - if ($filtered_errors) { - if ( php_sapi_name() != "cli" ) { - foreach ( $this->errors as $e => $msg ) { - static::alert ( $msg, LOG_WARNING, $this->network ); - } + if (!isset($_SERVER['HTTP_HOST'])) + $_SERVER['HTTP_HOST'] = '127.0.0.1'; + + /* set global config key; here, because it's needed for migration */ + if ( $this->network ) { + $this->global_config_key = 'network'; } - } - - add_filter('contextual_help', array( &$this, 'plugin_admin_nginx_help' ), 10, 2); - } - - /** - * activation hook function, to be extended - */ - public function plugin_activate() { - /* we leave this empty to avoid not detecting WP network correctly */ - } - - /** - * deactivation hook function, to be extended - */ - public function plugin_deactivate () { - /* remove current site config from global config */ - $this->update_global_config( true ); - } - - /** - * uninstall hook function, to be extended - */ - public function plugin_uninstall( $delete_options = true ) { - /* delete advanced-cache.php file */ - unlink ( $this->acache ); - - /* delete site settings */ - if ( $delete_options ) { - $this->plugin_options_delete (); - } - } - - /** - * once upgrade is finished, deploy advanced cache and save the new settings, just in case - */ - public function plugin_upgrade ( $upgrader_object, $hook_extra ) { - if (is_plugin_active( $this->plugin_constant . DIRECTORY_SEPARATOR . $this->plugin_constant . '.php' )) { - $this->update_global_config(); - $this->plugin_options_save(); - $this->deploy_advanced_cache(); - static::alert ( __('WP-FFPC settings were upgraded; please double check if everything is still working correctly.', 'wp-ffpc'), LOG_NOTICE ); - } - } - - /** - * extending admin init - * - */ - public function plugin_extend_admin_init () { - /* save parameter updates, if there are any */ - if ( isset( $_POST[ $this->button_flush ] ) && check_admin_referer ( 'wp-ffpc') ) { - /* remove precache log entry */ - static::_delete_option( self::precache_log ); - /* remove precache timestamp entry */ - static::_delete_option( self::precache_timestamp ); - - /* remove precache logfile */ - if ( @file_exists ( $this->precache_logfile ) ) { - unlink ( $this->precache_logfile ); - } - - /* remove precache PHP worker */ - if ( @file_exists ( $this->precache_phpfile ) ) { - unlink ( $this->precache_phpfile ); - } - - /* flush backend */ - $this->backend->clear( false, true ); - $this->status = 3; - header( "Location: ". $this->settings_link . self::slug_flush ); - } - - /* save parameter updates, if there are any */ - if ( isset( $_POST[ $this->button_precache ] ) && check_admin_referer ( 'wp-ffpc') ) { - /* is no shell function is possible, fail */ - if ( $this->shell_function == false ) { - $this->status = 5; - header( "Location: ". $this->settings_link . self::slug_precache_disabled ); - } - /* otherwise start full precache */ else { - $this->precache_message = $this->precache_coldrun(); - $this->status = 4; - header( "Location: ". $this->settings_link . self::slug_precache ); + $sitedomain = parse_url( get_option('siteurl') , PHP_URL_HOST); + if ( $_SERVER['HTTP_HOST'] != $sitedomain ) { + $this->errors['domain_mismatch'] = sprintf( __("Domain mismatch: the site domain configuration (%s) does not match the HTTP_HOST (%s) variable in PHP. Please fix the incorrect one, otherwise the plugin may not work as expected.", 'wp-ffpc'), $sitedomain, $_SERVER['HTTP_HOST'] ); + } + + $this->global_config_key = $_SERVER['HTTP_HOST']; + } + + /* cache type possible values array */ + $this->select_cache_type = array ( + 'apc' => __( 'APC' , 'wp-ffpc'), + 'apcu' => __( 'APCu' , 'wp-ffpc'), + 'memcache' => __( 'PHP Memcache' , 'wp-ffpc'), + 'memcached' => __( 'PHP Memcached' , 'wp-ffpc'), + 'redis' => __( 'Redis (experimental, it will break!)' , 'wp-ffpc'), + ); + /* check for required functions / classes for the cache types */ + + $this->valid_cache_type = array ( + 'apc' => (function_exists( 'apc_cache_info' ) && version_compare(PHP_VERSION, '5.3.0') <= 0 ) ? true : false, + 'apcu' => function_exists( 'apcu_cache_info' ) ? true : false, + 'memcache' => class_exists ( 'Memcache') ? true : false, + 'memcached' => class_exists ( 'Memcached') ? true : false, + 'redis' => class_exists( 'Redis' ) ? true : false, + ); + + /* invalidation method possible values array */ + $this->select_invalidation_method = array ( + 0 => __( 'flush cache' , 'wp-ffpc'), + 1 => __( 'only modified post' , 'wp-ffpc'), + 2 => __( 'modified post and all related taxonomies' , 'wp-ffpc'), + ); + + /* map of possible key masks */ + $this->list_uri_vars = array ( + '$scheme' => __('The HTTP scheme (i.e. http, https).', 'wp-ffpc'), + '$host' => __('Host in the header of request or name of the server processing the request if the Host header is not available.', 'wp-ffpc'), + '$request_uri' => __('The *original* request URI as received from the client including the args', 'wp-ffpc'), + '$remote_user' => __('Name of user, authenticated by the Auth Basic Module', 'wp-ffpc'), + '$cookie_PHPSESSID' => __('PHP Session Cookie ID, if set ( empty if not )', 'wp-ffpc'), + '$accept_lang' => __('First HTTP Accept Lang set in the HTTP request', 'wp-ffpc'), + //'$cookie_COOKnginy IE' => __('Value of COOKIE', 'wp-ffpc'), + //'$http_HEADER' => __('Value of HTTP request header HEADER ( lowercase, dashes converted to underscore )', 'wp-ffpc'), + //'$query_string' => __('Full request URI after rewrites', 'wp-ffpc'), + //'' => __('', 'wp-ffpc'), + ); + + /* get current wp_cron schedules */ + $wp_schedules = wp_get_schedules(); + /* add 'null' to switch off timed precache */ + $schedules['null'] = __( 'do not use timed precache' ); + foreach ( $wp_schedules as $interval=>$details ) { + $schedules[ $interval ] = $details['display']; + } + $this->select_schedules = $schedules; + + } + + /** + * additional init, steps that needs the plugin options + * + */ + public function plugin_post_init () { + + /* initiate backend */ + $backend_class = 'WP_FFPC_Backend_' . $this->options['cache_type']; + $this->backend = new $backend_class ( $this->options ); + + /* re-save settings after update */ + add_action( 'upgrader_process_complete', array ( &$this->plugin_upgrade ), 10, 2 ); + + /* cache invalidation hooks */ + add_action( 'transition_post_status', array( &$this->backend , 'clear_ng' ), 10, 3 ); + + /* comments invalidation hooks */ + if ( $this->options['comments_invalidate'] ) { + add_action( 'comment_post', array( &$this->backend , 'clear' ), 0 ); + add_action( 'edit_comment', array( &$this->backend , 'clear' ), 0 ); + add_action( 'trashed_comment', array( &$this->backend , 'clear' ), 0 ); + add_action( 'pingback_post', array( &$this->backend , 'clear' ), 0 ); + add_action( 'trackback_post', array( &$this->backend , 'clear' ), 0 ); + add_action( 'wp_insert_comment', array( &$this->backend , 'clear' ), 0 ); + } + + /* invalidation on some other ocasions as well */ + add_action( 'switch_theme', array( &$this->backend , 'clear' ), 0 ); + add_action( 'deleted_post', array( &$this->backend , 'clear' ), 0 ); + add_action( 'edit_post', array( &$this->backend , 'clear' ), 0 ); + + /* add filter for catching canonical redirects */ + if ( WP_CACHE ) + add_filter('redirect_canonical', 'wp_ffpc_redirect_callback', 10, 2); + + /* add precache coldrun action */ + add_action( self::precache_id , array( &$this, 'precache_coldrun' ) ); + + /* link on to settings for plugins page */ + $settings_link = ' » ' . __( 'WP-FFPC Settings', 'wp-ffpc') . ''; + + /* check & collect errors */ + /* look for WP_CACHE */ + if ( ! WP_CACHE ) + $this->errors['no_wp_cache'] = __("WP_CACHE is disabled. Without that, cache plugins, like this, will not work. Please add `define ( 'WP_CACHE', true );` to the beginning of wp-config.php.", 'wp-ffpc'); + + /* look for global settings array */ + if ( ! $this->global_saved ) + $this->errors['no_global_saved'] = sprintf( __('This site was reached as %s ( according to PHP HTTP_HOST ) and there are no settings present for this domain in the WP-FFPC configuration yet. Please save the %s for the domain or fix the webserver configuration!', 'wp-ffpc'), $_SERVER['HTTP_HOST'], $settings_link); + + /* look for writable acache file */ + if ( file_exists ( $this->acache ) && ! is_writable ( $this->acache ) ) + $this->errors['no_acache_write'] = sprintf(__('Advanced cache file (%s) is not writeable!
Please change the permissions on the file.', 'wp-ffpc'), $this->acache); + + /* look for acache file */ + if ( ! file_exists ( $this->acache ) ) + $this->errors['no_acache_saved'] = sprintf (__('Advanced cache file is yet to be generated, please save %s', 'wp-ffpc'), $settings_link ); + + /* look for extensions that should be available */ + foreach ( $this->valid_cache_type as $backend => $status ) { + if ( $this->options['cache_type'] == $backend && ! $status ) { + $this->errors['no_backend'] = sprintf ( __('%s cache backend activated but no PHP %s extension was found.
Please either use different backend or activate the module!', 'wp-ffpc'), $backend, $backend ); + } + } + + /* get the current runtime configuration for memcache in PHP because Memcache in binary mode is really problematic */ + if ( extension_loaded ( 'memcache' ) ) { + $memcache_settings = ini_get_all( 'memcache' ); + if ( !empty ( $memcache_settings ) && $this->options['cache_type'] == 'memcache' && isset($memcache_settings['memcache.protocol']) ) + { + $memcache_protocol = strtolower($memcache_settings['memcache.protocol']['local_value']); + if ( $memcache_protocol == 'binary' ) { + $this->errors['memcached_binary'] = __('WARNING: Memcache extension is configured to use binary mode. This is very buggy and the plugin will most probably not work correctly.
Please consider to change either to ASCII mode or to Memcached extension.', 'wp-ffpc'); + } + } + } + + $filtered_errors = apply_filters('wp_ffpc_post_init_errors_array', $this->errors); + if ($filtered_errors) { + if ( php_sapi_name() != "cli" ) { + foreach ( $this->errors as $e => $msg ) { + static::alert ( $msg, LOG_WARNING, $this->network ); + } + } + } + + add_filter('contextual_help', array( &$this, 'plugin_admin_nginx_help' ), 10, 2); + } + + /** + * activation hook function, to be extended + */ + public function plugin_activate() { + /* we leave this empty to avoid not detecting WP network correctly */ + } + + /** + * deactivation hook function, to be extended + */ + public function plugin_deactivate () { + /* remove current site config from global config */ + $this->update_global_config( true ); + } + + /** + * uninstall hook function, to be extended + */ + public function plugin_uninstall( $delete_options = true ) { + /* delete advanced-cache.php file */ + unlink ( $this->acache ); + + /* delete site settings */ + if ( $delete_options ) { + $this->plugin_options_delete (); } } - } - - /** - * admin help panel - */ - public function plugin_admin_help($contextual_help, $screen_id ) { - - /* add our page only if the screenid is correct */ - if ( strpos( $screen_id, $this->plugin_settings_page ) ) { - $contextual_help = __('

Please visit the official support forum of the plugin for help.

', 'wp-ffpc'); - - /* [TODO] give detailed information on errors & troubleshooting - get_current_screen()->add_help_tab( array( - 'id' => $this->plugin_constant . '-issues', - 'title' => __( 'Troubleshooting' ), - 'content' => __( '

List of errors, possible reasons and solutions

-
E#
- ' ) - ) ); - */ + /** + * once upgrade is finished, deploy advanced cache and save the new settings, just in case + */ + public function plugin_upgrade ( $upgrader_object, $hook_extra ) { + if (is_plugin_active( $this->plugin_constant . DIRECTORY_SEPARATOR . $this->plugin_constant . '.php' )) { + $this->update_global_config(); + $this->plugin_options_save(); + $this->deploy_advanced_cache(); + static::alert ( __('WP-FFPC settings were upgraded; please double check if everything is still working correctly.', 'wp-ffpc'), LOG_NOTICE ); + } } - return $contextual_help; - } + /** + * extending admin init + * + */ + public function plugin_extend_admin_init () { + /* save parameter updates, if there are any */ + if ( isset( $_POST[ $this->button_flush ] ) && check_admin_referer ( 'wp-ffpc') ) { + /* remove precache log entry */ + static::_delete_option( self::precache_log ); + /* remove precache timestamp entry */ + static::_delete_option( self::precache_timestamp ); - /** - * admin help panel - */ - public function plugin_admin_nginx_help($contextual_help, $screen_id ) { + /* remove precache logfile */ + if ( @file_exists ( $this->precache_logfile ) ) { + unlink ( $this->precache_logfile ); + } - /* add our page only if the screenid is correct */ - if ( strpos( $screen_id, $this->plugin_settings_page ) ) { - $content = __('

Sample config for nginx to utilize the data entries

', 'wp-ffpc'); - $content .= __('
This is not meant to be a copy-paste configuration; you most probably have to tailor it to your needs.
', 'wp-ffpc'); - $content .= __('
In case you are about to use nginx to fetch memcached entries directly and to use SHA1 hash keys, you will need an nginx version compiled with HttpSetMiscModule. Otherwise set_sha1 function is not available in nginx.
', 'wp-ffpc'); - $content .= '
' . $this->nginx_example() . '
'; + /* remove precache PHP worker */ + if ( @file_exists ( $this->precache_phpfile ) ) { + unlink ( $this->precache_phpfile ); + } - get_current_screen()->add_help_tab( array( + /* flush backend */ + $this->backend->clear( false, true ); + $this->status = 3; + header( "Location: ". $this->settings_link . self::slug_flush ); + } + + /* save parameter updates, if there are any */ + if ( isset( $_POST[ $this->button_precache ] ) && check_admin_referer ( 'wp-ffpc') ) { + /* is no shell function is possible, fail */ + if ( $this->shell_function == false ) { + $this->status = 5; + header( "Location: ". $this->settings_link . self::slug_precache_disabled ); + } + /* otherwise start full precache */ + else { + $this->precache_message = $this->precache_coldrun(); + $this->status = 4; + header( "Location: ". $this->settings_link . self::slug_precache ); + } + } + } + + /** + * admin help panel + */ + public function plugin_admin_help($contextual_help, $screen_id ) { + + /* add our page only if the screenid is correct */ + if ( strpos( $screen_id, $this->plugin_settings_page ) ) { + $contextual_help = __('

Please visit the official support forum of the plugin for help.

', 'wp-ffpc'); + + /* [TODO] give detailed information on errors & troubleshooting + get_current_screen()->add_help_tab( array( + 'id' => $this->plugin_constant . '-issues', + 'title' => __( 'Troubleshooting' ), + 'content' => __( '

List of errors, possible reasons and solutions

+
E#
+ ' ) + ) ); + */ + + } + + return $contextual_help; + } + + /** + * admin help panel + */ + public function plugin_admin_nginx_help($contextual_help, $screen_id ) { + + /* add our page only if the screenid is correct */ + if ( strpos( $screen_id, $this->plugin_settings_page ) ) { + $content = __('

Sample config for nginx to utilize the data entries

', 'wp-ffpc'); + $content .= __('
This is not meant to be a copy-paste configuration; you most probably have to tailor it to your needs.
', 'wp-ffpc'); + $content .= __('
In case you are about to use nginx to fetch memcached entries directly and to use SHA1 hash keys, you will need an nginx version compiled with HttpSetMiscModule. Otherwise set_sha1 function is not available in nginx.
', 'wp-ffpc'); + $content .= '
' . $this->nginx_example() . '
'; + + get_current_screen()->add_help_tab( array( 'id' => 'wp-ffpc-nginx-help', 'title' => __( 'nginx example', 'wp-ffpc' ), 'content' => $content, - ) ); + ) ); + } + + return $contextual_help; } - return $contextual_help; - } - - /** - * admin panel, the admin page displayed for plugin settings - */ - public function plugin_admin_panel() { /** - * security, if somehow we're running without WordPress security functions + * admin panel, the admin page displayed for plugin settings */ - if( ! function_exists( 'current_user_can' ) || ! current_user_can( 'manage_options' ) ){ - die( ); - } - - /* woo_commenrce page url */ - if ( class_exists( 'WooCommerce' ) ) { - $page_wc_checkout=str_replace( home_url(), '', wc_get_page_permalink( 'checkout' ) ); - $page_wc_myaccount=str_replace( home_url(), '', wc_get_page_permalink( 'myaccount' ) ); - $page_wc_cart=str_replace( home_url(), '', wc_get_page_permalink( 'cart' ) ); - $wcapi='^/wc-api|^/\?wc-api='; - $this->options['nocache_woocommerce_url'] = '^'.$page_wc_checkout.'|^'.$page_wc_myaccount.'|^'.$page_wc_cart.'|'.$wcapi; - - } else { - $this->options['nocache_woocommerce_url'] = ''; - } - - ?> + public function plugin_admin_panel() { + /** + * security, if somehow we're running without WordPress security functions + */ + if( ! function_exists( 'current_user_can' ) || ! current_user_can( 'manage_options' ) ){ + die( ); + } -
+ /* woo_commenrce page url */ + if ( class_exists( 'WooCommerce' ) ) { + $page_wc_checkout=str_replace( home_url(), '', wc_get_page_permalink( 'checkout' ) ); + $page_wc_myaccount=str_replace( home_url(), '', wc_get_page_permalink( 'myaccount' ) ); + $page_wc_cart=str_replace( home_url(), '', wc_get_page_permalink( 'cart' ) ); + $wcapi='^/wc-api|^/\?wc-api='; + $this->options['nocache_woocommerce_url'] = '^'.$page_wc_checkout.'|^'.$page_wc_myaccount.'|^'.$page_wc_cart.'|'.$wcapi; - + } else { + $this->options['nocache_woocommerce_url'] = ''; + } - - /* display donation form */ - $this->plugin_donation_form(); +
- /** - * if options were saved, display saved message - */ - if (isset($_GET[ self::key_save ]) && $_GET[ self::key_save ]=='true' || $this->status == 1) { ?> -

- + jQuery(document).ready(function($) { + jQuery( "#plugin_constant ?>-settings" ).tabs(); + jQuery( "#plugin_constant ?>-commands" ).tabs(); + }); + - /** - * if options were delete, display delete message - */ - if (isset($_GET[ self::key_delete ]) && $_GET[ self::key_delete ]=='true' || $this->status == 2) { ?> -

- status == 3) { ?> -

- plugin_donation_form(); - /** - * if options were saved, display saved message - */ - if ( ( isset($_GET[ self::key_precache ]) && $_GET[ self::key_precache ]=='true' ) || $this->status == 4) { ?> -

- status == 1) { ?> +

+ + /** + * if options were delete, display delete message + */ + if (isset($_GET[ self::key_delete ]) && $_GET[ self::key_delete ]=='true' || $this->status == 2) { ?> +

+ plugin_name ; _e( ' settings', 'wp-ffpc') ; ?> + /** + * if options were saved + */ + if (isset($_GET[ self::key_flush ]) && $_GET[ self::key_flush ]=='true' || $this->status == 3) { ?> +

+ -

options['cache_type']; ?>

- options['cache_type'], 'memcache') ) { - ?>

Backend status:
', 'wp-ffpc'); + /** + * if options were saved, display saved message + */ + if ( ( isset($_GET[ self::key_precache ]) && $_GET[ self::key_precache ]=='true' ) || $this->status == 4) { ?> +

+ backend->status(); - error_log(__CLASS__ . ':' .json_encode($servers)); - if ( is_array( $servers ) && !empty ( $servers ) ) { - foreach ( $servers as $server_string => $status ) { - echo $server_string ." => "; + /** + * the admin panel itself + */ + ?> - if ( $status == 0 ) - _e ( 'down
', 'wp-ffpc'); - elseif ( ( $this->options['cache_type'] == 'memcache' && $status > 0 ) || $status == 1 ) - _e ( 'up & running
', 'wp-ffpc'); - else - _e ( 'unknown, please try re-saving settings!
', 'wp-ffpc'); - } - } +

plugin_name ; _e( ' settings', 'wp-ffpc') ; ?>

- ?>

-
-
+
+

options['cache_type']; ?>

+ options['cache_type'], 'memcache') ) { + ?>

Backend status:
', 'wp-ffpc'); - + /* we need to go through all servers */ + $servers = $this->backend->status(); + error_log(__CLASS__ . ':' .json_encode($servers)); + if ( is_array( $servers ) && !empty ( $servers ) ) { + foreach ( $servers as $server_string => $status ) { + echo $server_string ." => "; - plugin_admin_panel_get_tabs(); ?> -

    - $tab_label): ?> -
    • - -
+ if ( $status == 0 ) + _e ( 'down
', 'wp-ffpc'); + elseif ( ( $this->options['cache_type'] == 'memcache' && $status > 0 ) || $status == 1 ) + _e ( 'up & running
', 'wp-ffpc'); + else + _e ( 'unknown, please try re-saving settings!
', 'wp-ffpc'); + } + } -
- -
-
- -
-
- - -
+ ?>

+
+ -
- -
-
- - -
+ -
- -
-
- - -
+ plugin_admin_panel_get_tabs(); ?> +
    + $tab_label): ?> +
    • + +
-
- -
-
- - -
+
+ +
+
+ +
+
+ + +
-
- -
-
- - -
+
+ +
+
+ + +
-
- -
-
- - -
+
+ +
+
+ + +
-
- -
-
- - -
+
+ +
+
+ + +
-
- -
-
- - -
+
+ +
+
+ + +
-
- -
-
- -
-
    - including values set by other applications', - 'clear only the modified posts entry, everything else remains in cache', - 'unvalidates post and the taxonomy related to the post', - ); - foreach ($this->select_invalidation_method AS $current_key => $current_invalidation_method) { - printf('
  1. %1$s - %2$s
    2. ', $current_invalidation_method, $invalidation_method_description[$current_key]); - } ?> -
-
-
+
+ +
+
+ + +
-
- -
-
- options['comments_invalidate'],true); ?> /> - -
+
+ +
+
+ + +
-
- -
-
- - WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> -
+
+ +
+
+ + +
-
- -
-
- - WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> -
+
+ +
+
+ +
+
    + including values set by other applications', + 'clear only the modified posts entry, everything else remains in cache', + 'unvalidates post and the taxonomy related to the post', + ); + foreach ($this->select_invalidation_method AS $current_key => $current_invalidation_method) { + printf('
  1. %1$s - %2$s
    2. ', $current_invalidation_method, $invalidation_method_description[$current_key]); + } ?> +
+
+
-
- -
-
- - WARNING: changing this will result the previous cache to becomes invalid!', 'wp-ffpc'); ?> -
+
+ +
+
+ options['comments_invalidate'],true); ?> /> + +
-
- -
-
- - WARNING: changing this will result the previous cache to becomes invalid!', 'wp-ffpc'); ?> -
+
+ +
+
+ + WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> +
-
- -
-
- - use the guide below to change it.
WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> -
list_uri_vars as $uri => $desc ) { - echo '
'. $uri .'
'. $desc .'
'; - } - ?>
-
+
+ +
+
+ + WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> +
-
- -
-
- options['hashkey'],true); ?> /> - module in nginx if you want nginx to fetch the data directly; for details, please see the nginx example tab.', 'wp-ffpc'); ?> -
+
+ +
+
+ + WARNING: changing this will result the previous cache to becomes invalid!', 'wp-ffpc'); ?> +
+ +
+ +
+
+ + WARNING: changing this will result the previous cache to becomes invalid!', 'wp-ffpc'); ?> +
+ +
+ +
+
+ + use the guide below to change it.
WARNING: changing this will result the previous cache to becomes invalid!
If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> +
list_uri_vars as $uri => $desc ) { + echo '
'. $uri .'
'. $desc .'
'; + } + ?>
+
+ +
+ +
+
+ options['hashkey'],true); ?> /> + module in nginx if you want nginx to fetch the data directly; for details, please see the nginx example tab.', 'wp-ffpc'); ?> +
-
-
+
+ -
- -

-

WP_DEBUG and the WP_FFPC__DEBUG_MODE constants `true` in wp-config.php.
This will enable NOTICE level messages apart from the WARNING level ones which are always displayed.', 'wp-ffpc'); ?>

+
+ +

+

WP_DEBUG and the WP_FFPC__DEBUG_MODE constants `true` in wp-config.php.
This will enable NOTICE level messages apart from the WARNING level ones which are always displayed.', 'wp-ffpc'); ?>

-
-
- -
-
- options['pingback_header'],true); ?> /> - -
+
+
+ +
+
+ options['pingback_header'],true); ?> /> + +
-
- -
-
- options['response_header'],true); ?> /> - -
+
+ +
+
+ options['response_header'],true); ?> /> + +
-
- -
-
- options['generate_time'],true); ?> /> - tag.', 'wp-ffpc'); ?> -
+
+ +
+
+ options['generate_time'],true); ?> /> + tag.', 'wp-ffpc'); ?> +
-
+
-
+
-
- -
-
- -
-
- options['cache_loggedin'],true); ?> /> - -
+
+ +
+
+ +
+
+ options['cache_loggedin'],true); ?> /> + +
-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - -
- options['nocache_home'],true); ?> /> - - - options['nocache_feed'],true); ?> /> - - - options['nocache_archive'],true); ?> /> - - - options['nocache_page'],true); ?> /> - - - options['nocache_single'],true); ?> /> - - - options['nocache_dyn'],true); ?> /> - - - - options['nocache_woocommerce'],true); ?> /> - - options['nocache_woocommerce_url'] ) ) echo "
Url:".$this->options['nocache_woocommerce_url']; ?> -
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ options['nocache_home'],true); ?> /> + + + options['nocache_feed'],true); ?> /> + + + options['nocache_archive'],true); ?> /> + + + options['nocache_page'],true); ?> /> + + + options['nocache_single'],true); ?> /> + + + options['nocache_dyn'],true); ?> /> + + + + options['nocache_woocommerce'],true); ?> /> + + options['nocache_woocommerce_url'] ) ) echo "
Url:".$this->options['nocache_woocommerce_url']; ?> +
-
- -
-
- - If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> -
+
+ +
+
+ + If you are caching with nginx, you should update your nginx configuration and reload nginx after changing this value.', 'wp-ffpc'); ?> +
-
- -
-
+
+ +
+
- pattern1|pattern2|etc', 'wp-ffpc'); ?> -
+ ?> + pattern1|pattern2|etc', 'wp-ffpc'); ?> + -
- -
-
- - . Regular expressions use you must! e.g. pattern1|pattern2|etc
+
+ +
+
+ + . Regular expressions use you must! e.g. pattern1|pattern2|etc
WARNING: be careful where you display this, because it will apply to any content, including archives, collection pages, singles, anything. If empty, this setting will be ignored.', 'wp-ffpc'); ?> -
+ - - + + -
- -
-
- -
-
- - +
+ +
+
+ +
+
+ + - in case of TCP based connections, list the servers as host1:port1,host2:port2,... . Do not add trailing , and always separate host and port with : .
- for a unix socket enter: unix://[socket_path]', 'wp-ffpc'); ?> -
+
-

- options['authuser'] ) || !empty( $this->options['authpass'] ) ) ) { ?> -

- -
- -
-
- - +

+ options['authuser'] ) || !empty( $this->options['authpass'] ) ) ) { ?> +

+ +
+ +
+
+ + -
+ -
- -
-
- - +
+ +
+
+ + -
+ -

-
- -
-
- options['memcached_binary'],true); ?> /> - -
+

+
+ +
+
+ options['memcached_binary'],true); ?> /> + +
-
-
+ + -
- +
+ -
- -
-
- - -
+
+ +
+
+ + +
- network ); - $log = static::_get_option( self::precache_log, $this->network ); - - if ( @file_exists ( $this->precache_logfile ) ) { - $logtime = filemtime ( $this->precache_logfile ); - - /* update precache log in DB if needed */ - if ( $logtime > $gentime ) { - $log = file ( $this->precache_logfile ); - static::_update_option( self::precache_log , $log, $this->network ); - static::_update_option( self::precache_timestamp , $logtime, $this->network ); - } - - } - - if ( empty ( $log ) ) { - _e('No precache log was found!', 'wp-ffpc'); - } - else { ?> -

-
- - - - - - - - - - + + $gentime = static::_get_option( self::precache_timestamp, $this->network ); + $log = static::_get_option( self::precache_log, $this->network ); + + if ( @file_exists ( $this->precache_logfile ) ) { + $logtime = filemtime ( $this->precache_logfile ); + + /* update precache log in DB if needed */ + if ( $logtime > $gentime ) { + $log = file ( $this->precache_logfile ); + static::_update_option( self::precache_log , $log, $this->network ); + static::_update_option( self::precache_timestamp , $logtime, $this->network ); + } + + } + + if ( empty ( $log ) ) { + _e('No precache log was found!', 'wp-ffpc'); + } + else { ?> +

+
+ + + + + + + + + + + + +
- - -
+
- + -

- -

+

+ +

- + -
+ - + -
    -
    • -
    • -
    • -
+
    +
    • +
    • +
    • +
-
- -
-
- status == 5 || $this->shell_function == false ) { ?> - Since precaching may take a very long time, it's done through a background CLI process in order not to run out of max execution time of PHP. Please enable one of the following functions if you whish to use precaching: " , 'wp-ffpc') ?>shell_possibilities ); ?> - - - -
-
- The plugin tries to visit links of taxonomy terms without the taxonomy name as well. This may generate 404 hits, please be prepared for these in your logfiles if you plan to pre-cache.', 'wp-ffpc'); ?> -
-
-
-
- -
-
- -
-
- -
-
-
-
- -
-
- -
-
- -
-
-
-
- - __( 'Cache type', 'wp-ffpc'), - 'debug' => __( 'Debug & in-depth', 'wp-ffpc'), - 'exceptions' => __( 'Cache exceptions', 'wp-ffpc'), - 'servers' => __( 'Backend settings', 'wp-ffpc'), - 'precache' => __( 'Precache & precache log', 'wp-ffpc') - ); - - return apply_filters('wp_ffpc_admin_panel_tabs', $default_tabs); - } - - /** - * extending options_save - * - */ - public function plugin_extend_options_save( $activating ) { - - /* schedule cron if posted */ - $schedule = wp_get_schedule( self::precache_id ); - if ( $this->options['precache_schedule'] != 'null' ) { - /* clear all other schedules before adding a new in order to replace */ - wp_clear_scheduled_hook ( self::precache_id ); - static::debug ( $this->plugin_constant, __( 'Scheduling WP-CRON event', 'wp-ffpc') ); - $this->scheduled = wp_schedule_event( time(), $this->options['precache_schedule'] , self::precache_id ); - } - elseif ( ( !isset($this->options['precache_schedule']) || $this->options['precache_schedule'] == 'null' ) && !empty( $schedule ) ) { - static::debug ( $this->plugin_constant, __('Clearing WP-CRON scheduled hook ' , 'wp-ffpc') ); - wp_clear_scheduled_hook ( self::precache_id ); +
+ +
+
+ status == 5 || $this->shell_function == false ) { ?> + Since precaching may take a very long time, it's done through a background CLI process in order not to run out of max execution time of PHP. Please enable one of the following functions if you whish to use precaching: " , 'wp-ffpc') ?>shell_possibilities ); ?> + + + +
+
+ The plugin tries to visit links of taxonomy terms without the taxonomy name as well. This may generate 404 hits, please be prepared for these in your logfiles if you plan to pre-cache.', 'wp-ffpc'); ?> +
+
+
+
+ +
+
+ +
+
+ +
+
+
+
+ +
+
+ +
+
+ +
+
+
+ + + backend->clear(null, true); + private function plugin_admin_panel_get_tabs() { + $default_tabs = array( + 'type' => __( 'Cache type', 'wp-ffpc'), + 'debug' => __( 'Debug & in-depth', 'wp-ffpc'), + 'exceptions' => __( 'Cache exceptions', 'wp-ffpc'), + 'servers' => __( 'Backend settings', 'wp-ffpc'), + 'precache' => __( 'Precache & precache log', 'wp-ffpc') + ); - /* create the to-be-included configuration for advanced-cache.php */ - $this->update_global_config(); + return apply_filters('wp_ffpc_admin_panel_tabs', $default_tabs); + } - /* create advanced cache file, needed only once or on activation, because there could be lefover advanced-cache.php from different plugins */ - if ( !$activating ) - $this->deploy_advanced_cache(); + /** + * extending options_save + * + */ + public function plugin_extend_options_save( $activating ) { - } - - /** - * read hook; needs to be implemented - */ - public function plugin_extend_options_read( &$options ) { - /*if ( strstr( $this->options['nocache_url']), '^wp-' )wp_login_url() - $this->options['nocache_url'] = */ - - - /* read the global options, network compatibility */ - $this->global_config = get_site_option( $this->global_option ); - - /* check if current site present in global config */ - if ( !empty ( $this->global_config[ $this->global_config_key ] ) ) - $this->global_saved = true; - - $this->global_config[ $this->global_config_key ] = $options; - } - - /** - * options delete hook; needs to be implemented - */ - public function plugin_extend_options_delete( ) { - delete_site_option ( $this->global_option ); - } - - /** - * need to do migrations from previous versions of the plugin - * - */ - public function plugin_options_migrate( &$options ) { - - if ( version_compare ( $options['version'] , $this->plugin_version, '<' ) ) { - /* cleanup possible leftover files from previous versions */ - $check = array ( 'advanced-cache.php', 'nginx-sample.conf', 'wp-ffpc.admin.css', 'wp-ffpc-common.php' ); - foreach ( $check as $fname ) { - $fname = $this->plugin_dir . $fname; - if ( file_exists ( $fname ) ) - unlink ( $fname ); + /* schedule cron if posted */ + $schedule = wp_get_schedule( self::precache_id ); + if ( $this->options['precache_schedule'] != 'null' ) { + /* clear all other schedules before adding a new in order to replace */ + wp_clear_scheduled_hook ( self::precache_id ); + static::debug ( $this->plugin_constant, __( 'Scheduling WP-CRON event', 'wp-ffpc') ); + $this->scheduled = wp_schedule_event( time(), $this->options['precache_schedule'] , self::precache_id ); + } + elseif ( ( !isset($this->options['precache_schedule']) || $this->options['precache_schedule'] == 'null' ) && !empty( $schedule ) ) { + static::debug ( $this->plugin_constant, __('Clearing WP-CRON scheduled hook ' , 'wp-ffpc') ); + wp_clear_scheduled_hook ( self::precache_id ); } - /* look for previous config leftovers */ - $try = get_site_option( 'wp-ffpc'); - /* network option key changed, remove & migrate the leftovers if there's any */ - if ( !empty ( $try ) && $this->network ) { - /* clean it up, we don't use it anymore */ - delete_site_option ( 'wp-ffpc'); + /* flush the cache when new options are saved, not needed on activation */ + if ( !$activating ) + $this->backend->clear(null, true); - if ( empty ( $options ) && array_key_exists ( $this->global_config_key, $try ) ) { - $options = $try [ $this->global_config_key ]; + /* create the to-be-included configuration for advanced-cache.php */ + $this->update_global_config(); + + /* create advanced cache file, needed only once or on activation, because there could be lefover advanced-cache.php from different plugins */ + if ( !$activating ) + $this->deploy_advanced_cache(); + + } + + /** + * read hook; needs to be implemented + */ + public function plugin_extend_options_read( &$options ) { + /*if ( strstr( $this->options['nocache_url']), '^wp-' )wp_login_url() + $this->options['nocache_url'] = */ + + + /* read the global options, network compatibility */ + $this->global_config = get_site_option( $this->global_option ); + + /* check if current site present in global config */ + if ( !empty ( $this->global_config[ $this->global_config_key ] ) ) + $this->global_saved = true; + + $this->global_config[ $this->global_config_key ] = $options; + } + + /** + * options delete hook; needs to be implemented + */ + public function plugin_extend_options_delete( ) { + delete_site_option ( $this->global_option ); + } + + /** + * need to do migrations from previous versions of the plugin + * + */ + public function plugin_options_migrate( &$options ) { + + if ( version_compare ( $options['version'] , $this->plugin_version, '<' ) ) { + /* cleanup possible leftover files from previous versions */ + $check = array ( 'advanced-cache.php', 'nginx-sample.conf', 'wp-ffpc.admin.css', 'wp-ffpc-common.php' ); + foreach ( $check as $fname ) { + $fname = $this->plugin_dir . $fname; + if ( file_exists ( $fname ) ) + unlink ( $fname ); } - elseif ( empty ( $options ) && array_key_exists ( 'host', $try ) ) { - $options = $try; + + /* look for previous config leftovers */ + $try = get_site_option( 'wp-ffpc'); + /* network option key changed, remove & migrate the leftovers if there's any */ + if ( !empty ( $try ) && $this->network ) { + /* clean it up, we don't use it anymore */ + delete_site_option ( 'wp-ffpc'); + + if ( empty ( $options ) && array_key_exists ( $this->global_config_key, $try ) ) { + $options = $try [ $this->global_config_key ]; + } + elseif ( empty ( $options ) && array_key_exists ( 'host', $try ) ) { + $options = $try; + } } - } - /* updating from version <= 0.4.x */ - if ( !empty ( $options['host'] ) ) { - $options['hosts'] = $options['host'] . ':' . $options['port']; + /* updating from version <= 0.4.x */ + if ( !empty ( $options['host'] ) ) { + $options['hosts'] = $options['host'] . ':' . $options['port']; + } + /* migrating from version 0.6.x */ + elseif ( is_array ( $options ) && array_key_exists ( $this->global_config_key , $options ) ) { + $options = $options[ $this->global_config_key ]; + } + + /* renamed options */ + if ( isset ( $options['syslog'] ) ) + $options['log'] = $options['syslog']; + if ( isset ( $options['debug'] ) ) + $options['response_header'] = $options['debug']; } - /* migrating from version 0.6.x */ - elseif ( is_array ( $options ) && array_key_exists ( $this->global_config_key , $options ) ) { - $options = $options[ $this->global_config_key ]; + } + + /** + * advanced-cache.php creator function + * + */ + private function deploy_advanced_cache( ) { + + if (!touch($this->acache)) { + error_log('Generating advanced-cache.php failed: '.$this->acache.' is not writable'); + return false; } - /* renamed options */ - if ( isset ( $options['syslog'] ) ) - $options['log'] = $options['syslog']; - if ( isset ( $options['debug'] ) ) - $options['response_header'] = $options['debug']; - } - } + /* if no active site left no need for advanced cache :( */ + if ( empty ( $this->global_config ) ) { + error_log('Generating advanced-cache.php failed: Global config is empty'); + return false; + } - /** - * advanced-cache.php creator function - * - */ - private function deploy_advanced_cache( ) { - if (!touch($this->acache)) { - error_log('Generating advanced-cache.php failed: '.$this->acache.' is not writable'); - return false; + /* add the required includes and generate the needed code */ + $string[] = "global_config, true ) . ';' ; + //$string[] = "include_once ('" . $this->acache_backend . "');"; + $string[] = "include_once ('" . $this->acache_worker . "');"; + + /* write the file and start caching from this point */ + return file_put_contents( $this->acache, join( "\n" , $string ) ); + } - /* if no active site left no need for advanced cache :( */ - if ( empty ( $this->global_config ) ) { - error_log('Generating advanced-cache.php failed: Global config is empty'); - return false; - } + /** + * function to generate working example from the nginx sample file + * + * @return string nginx config file + * + */ + private function nginx_example () { + /* read the sample file */ + $nginx = file_get_contents ( $this->nginx_sample ); - - /* add the required includes and generate the needed code */ - $string[] = "global_config, true ) . ';' ; - //$string[] = "include_once ('" . $this->acache_backend . "');"; - $string[] = "include_once ('" . $this->acache_worker . "');"; - - /* write the file and start caching from this point */ - return file_put_contents( $this->acache, join( "\n" , $string ) ); - - } - - /** - * function to generate working example from the nginx sample file - * - * @return string nginx config file - * - */ - private function nginx_example () { - /* read the sample file */ - $nginx = file_get_contents ( $this->nginx_sample ); - - if ( isset($this->options['hashkey']) && $this->options['hashkey'] == true ) - $mckeys = ' set_sha1 $memcached_sha1_key $memcached_raw_key; + if ( isset($this->options['hashkey']) && $this->options['hashkey'] == true ) + $mckeys = ' set_sha1 $memcached_sha1_key $memcached_raw_key; set $memcached_key DATAPREFIX$memcached_sha1_key;'; - else - $mckeys = ' set $memcached_key DATAPREFIX$memcached_raw_key;'; + else + $mckeys = ' set $memcached_key DATAPREFIX$memcached_raw_key;'; - $nginx = str_replace ( 'HASHEDORNOT' , $mckeys , $nginx ); + $nginx = str_replace ( 'HASHEDORNOT' , $mckeys , $nginx ); - /* replace the data prefix with the configured one */ - $to_replace = array ( 'DATAPREFIX' , 'KEYFORMAT', 'SERVERROOT', 'SERVERLOG' ); - $replace_with = array ( $this->options['prefix_data'], $this->options['key'] , ABSPATH, $_SERVER['SERVER_NAME'] ); - $nginx = str_replace ( $to_replace , $replace_with , $nginx ); + /* replace the data prefix with the configured one */ + $to_replace = array ( 'DATAPREFIX' , 'KEYFORMAT', 'SERVERROOT', 'SERVERLOG' ); + $replace_with = array ( $this->options['prefix_data'], $this->options['key'] , ABSPATH, $_SERVER['SERVER_NAME'] ); + $nginx = str_replace ( $to_replace , $replace_with , $nginx ); - /* set upstream servers from configured servers, best to get from the actual backend */ - $servers = $this->backend->get_servers(); - $nginx_servers = ''; - if ( is_array ( $servers )) { - foreach ( array_keys( $servers ) as $server ) { - $nginx_servers .= " server ". $server .";\n"; + /* set upstream servers from configured servers, best to get from the actual backend */ + $servers = $this->backend->get_servers(); + $nginx_servers = ''; + if ( is_array ( $servers )) { + foreach ( array_keys( $servers ) as $server ) { + $nginx_servers .= " server ". $server .";\n"; + } } - } - else { - $nginx_servers .= " server ". $servers .";\n"; - } - $nginx = str_replace ( 'MEMCACHED_SERVERS' , $nginx_servers , $nginx ); + else { + $nginx_servers .= " server ". $servers .";\n"; + } + $nginx = str_replace ( 'MEMCACHED_SERVERS' , $nginx_servers , $nginx ); - $loggedincookies = join('|', $this->backend->cookies ); - /* this part is not used when the cache is turned on for logged in users */ - $loggedin = ' + $loggedincookies = join('|', $this->backend->cookies ); + /* this part is not used when the cache is turned on for logged in users */ + $loggedin = ' if ($http_cookie ~* "'. $loggedincookies .'" ) { set $memcached_request 0; }'; - /* add logged in cache, if valid */ - if ( ! $this->options['cache_loggedin']) - $nginx = str_replace ( 'LOGGEDIN_EXCEPTION' , $loggedin , $nginx ); - else - $nginx = str_replace ( 'LOGGEDIN_EXCEPTION' , '' , $nginx ); + /* add logged in cache, if valid */ + if ( ! $this->options['cache_loggedin']) + $nginx = str_replace ( 'LOGGEDIN_EXCEPTION' , $loggedin , $nginx ); + else + $nginx = str_replace ( 'LOGGEDIN_EXCEPTION' , '' , $nginx ); - /* nginx can skip caching for visitors with certain cookies specified in the options */ - if( $this->options['nocache_cookies'] ) { - $cookies = str_replace( ",","|", $this->options['nocache_cookies'] ); - $cookies = str_replace( " ","", $cookies ); - $cookie_exception = '# avoid cache for cookies specified + /* nginx can skip caching for visitors with certain cookies specified in the options */ + if( $this->options['nocache_cookies'] ) { + $cookies = str_replace( ",","|", $this->options['nocache_cookies'] ); + $cookies = str_replace( " ","", $cookies ); + $cookie_exception = '# avoid cache for cookies specified if ($http_cookie ~* ' . $cookies . ' ) { set $memcached_request 0; }'; - $nginx = str_replace ( 'COOKIES_EXCEPTION' , $cookie_exception , $nginx ); - } else { - $nginx = str_replace ( 'COOKIES_EXCEPTION' , '' , $nginx ); + $nginx = str_replace ( 'COOKIES_EXCEPTION' , $cookie_exception , $nginx ); + } else { + $nginx = str_replace ( 'COOKIES_EXCEPTION' , '' , $nginx ); + } + + /* add custom response header if specified in the options */ + if( $this->options['response_header'] && strstr ( $this->options['cache_type'], 'memcached') ) { + $response_header = 'add_header X-Cache-Engine "WP-FFPC with ' . $this->options['cache_type'] .' via nginx";'; + $nginx = str_replace ( 'RESPONSE_HEADER' , $response_header , $nginx ); + } + else { + $nginx = str_replace ( 'RESPONSE_HEADER' , '' , $nginx ); + } + + return htmlspecialchars($nginx); } - /* add custom response header if specified in the options */ - if( $this->options['response_header'] && strstr ( $this->options['cache_type'], 'memcached') ) { - $response_header = 'add_header X-Cache-Engine "WP-FFPC with ' . $this->options['cache_type'] .' via nginx";'; - $nginx = str_replace ( 'RESPONSE_HEADER' , $response_header , $nginx ); - } - else { - $nginx = str_replace ( 'RESPONSE_HEADER' , '' , $nginx ); + /** + * function to update global configuration + * + * @param boolean $remove_site Bool to remove or add current config to global + * + */ + private function update_global_config ( $remove_site = false ) { + + /* remove or add current config to global config */ + if ( $remove_site ) { + unset ( $this->global_config[ $this->global_config_key ] ); + } + else { + $this->global_config[ $this->global_config_key ] = $this->options; + } + + /* deploy advanced-cache.php */ + $this->deploy_advanced_cache (); + + /* save options to database */ + update_site_option( $this->global_option , $this->global_config ); } - return htmlspecialchars($nginx); - } - /** - * function to update global configuration - * - * @param boolean $remove_site Bool to remove or add current config to global - * - */ - private function update_global_config ( $remove_site = false ) { + /** + * generate cache entry for every available permalink, might be very-very slow, + * therefore it starts a background process + * + */ + private function precache ( &$links ) { - /* remove or add current config to global config */ - if ( $remove_site ) { - unset ( $this->global_config[ $this->global_config_key ] ); - } - else { - $this->global_config[ $this->global_config_key ] = $this->options; - } + /* double check if we do have any links to pre-cache */ + if ( !empty ( $links ) && !$this->precache_running() ) { - /* deploy advanced-cache.php */ - $this->deploy_advanced_cache (); - - /* save options to database */ - update_site_option( $this->global_option , $this->global_config ); - } - - - /** - * generate cache entry for every available permalink, might be very-very slow, - * therefore it starts a background process - * - */ - private function precache ( &$links ) { - - /* double check if we do have any links to pre-cache */ - if ( !empty ( $links ) && !$this->precache_running() ) { - - $out = 'precache_phpfile .'" ); ?>'; - file_put_contents ( $this->precache_phpfile, $out ); - /* call the precache worker file in the background */ - $shellfunction = $this->shell_function; - $shellfunction( 'php '. $this->precache_phpfile .' >'. $this->precache_logfile .' 2>&1 &' ); + file_put_contents ( $this->precache_phpfile, $out ); + /* call the precache worker file in the background */ + $shellfunction = $this->shell_function; + $shellfunction( 'php '. $this->precache_phpfile .' >'. $this->precache_logfile .' 2>&1 &' ); + } + } - } + /** + * check is precache is still ongoing + * + */ + private function precache_running () { + $return = false; - /** - * check is precache is still ongoing - * - */ - private function precache_running () { - $return = false; - - /* if the precache file exists, it did not finish running as it should delete itself on finish */ - if ( file_exists ( $this->precache_phpfile )) { - $return = true; - } - /* - [TODO] cross-platform process check; this is *nix only - else { - $shellfunction = $this->shell_function; - $running = $shellfunction( "ps aux | grep \"". $this->precache_phpfile ."\" | grep -v grep | awk '{print $2}'" ); - if ( is_int( $running ) && $running != 0 ) { + /* if the precache file exists, it did not finish running as it should delete itself on finish */ + if ( file_exists ( $this->precache_phpfile )) { $return = true; } - } - */ - - return $return; - } - - /** - * run full-site precache - */ - public function precache_coldrun () { - - /* container for links to precache, well be accessed by reference */ - $links = array(); - - /* when plugin is network wide active, we need to pre-cache for all link of all blogs */ - if ( $this->network ) { - /* list all blogs */ - global $wpdb; - $pfix = empty ( $wpdb->base_prefix ) ? 'wp_' : $wpdb->base_prefix; - $blog_list = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM ". $pfix ."blogs ORDER BY blog_id", '' ) ); - - foreach ($blog_list as $blog) { - if ( $blog->archived != 1 && $blog->spam != 1 && $blog->deleted != 1) { - /* get permalinks for this blog */ - $this->precache_list_permalinks ( $links, $blog->blog_id ); + /* + [TODO] cross-platform process check; this is *nix only + else { + $shellfunction = $this->shell_function; + $running = $shellfunction( "ps aux | grep \"". $this->precache_phpfile ."\" | grep -v grep | awk '{print $2}'" ); + if ( is_int( $running ) && $running != 0 ) { + $return = true; } } - } - else { - /* no network, better */ - $this->precache_list_permalinks ( $links, false ); + */ + + return $return; } - /* double check if we do have any links to pre-cache */ - if ( !empty ( $links ) ) { - $this->precache ( $links ); - } - } + /** + * run full-site precache + */ + public function precache_coldrun () { - /** - * gets all post-like entry permalinks for a site, returns values in passed-by-reference array - * - */ - private function precache_list_permalinks ( &$links, $site = false ) { - /* $post will be populated when running throught the posts */ - global $post; - include_once ( ABSPATH . "wp-load.php" ); + /* container for links to precache, well be accessed by reference */ + $links = array(); - /* if a site id was provided, save current blog and change to the other site */ - if ( $site !== false ) { - $current_blog = get_current_blog_id(); - switch_to_blog( $site ); + /* when plugin is network wide active, we need to pre-cache for all link of all blogs */ + if ( $this->network ) { + /* list all blogs */ + global $wpdb; + $pfix = empty ( $wpdb->base_prefix ) ? 'wp_' : $wpdb->base_prefix; + $blog_list = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM ". $pfix ."blogs ORDER BY blog_id", '' ) ); - $url = $this->_site_url( $site ); - //$url = get_blog_option ( $site, 'siteurl' ); - if ( substr( $url, -1) !== '/' ) - $url = $url . '/'; - - $links[ $url ] = true; - } - - /* get all published posts */ - $args = array ( - 'post_type' => 'any', - 'posts_per_page' => -1, - 'post_status' => 'publish', - ); - $posts = new WP_Query( $args ); - - /* get all the posts, one by one */ - while ( $posts->have_posts() ) { - $posts->the_post(); - - /* get the permalink for currently selected post */ - switch ($post->post_type) { - case 'revision': - case 'nav_menu_item': - break; - case 'page': - $permalink = get_page_link( $post->ID ); - break; - /* - * case 'post': - $permalink = get_permalink( $post->ID ); - break; - */ - case 'attachment': - $permalink = get_attachment_link( $post->ID ); - break; - default: - $permalink = get_permalink( $post->ID ); - break; + foreach ($blog_list as $blog) { + if ( $blog->archived != 1 && $blog->spam != 1 && $blog->deleted != 1) { + /* get permalinks for this blog */ + $this->precache_list_permalinks ( $links, $blog->blog_id ); + } + } + } + else { + /* no network, better */ + $this->precache_list_permalinks ( $links, false ); } - /* in case the bloglinks are relative links add the base url, site specific */ - $baseurl = empty( $url ) ? static::_site_url() : $url; - if ( !strstr( $permalink, $baseurl ) ) { - $permalink = $baseurl . $permalink; + /* double check if we do have any links to pre-cache */ + if ( !empty ( $links ) ) { + $this->precache ( $links ); + } + } + + /** + * gets all post-like entry permalinks for a site, returns values in passed-by-reference array + * + */ + private function precache_list_permalinks ( &$links, $site = false ) { + /* $post will be populated when running throught the posts */ + global $post; + include_once ( ABSPATH . "wp-load.php" ); + + /* if a site id was provided, save current blog and change to the other site */ + if ( $site !== false ) { + $current_blog = get_current_blog_id(); + switch_to_blog( $site ); + + $url = $this->_site_url( $site ); + //$url = get_blog_option ( $site, 'siteurl' ); + if ( substr( $url, -1) !== '/' ) + $url = $url . '/'; + + $links[ $url ] = true; } - /* collect permalinks */ - $links[ $permalink ] = true; + /* get all published posts */ + $args = array ( + 'post_type' => 'any', + 'posts_per_page' => -1, + 'post_status' => 'publish', + ); + $posts = new WP_Query( $args ); + /* get all the posts, one by one */ + while ( $posts->have_posts() ) { + $posts->the_post(); + + /* get the permalink for currently selected post */ + switch ($post->post_type) { + case 'revision': + case 'nav_menu_item': + break; + case 'page': + $permalink = get_page_link( $post->ID ); + break; + /* + * case 'post': + $permalink = get_permalink( $post->ID ); + break; + */ + case 'attachment': + $permalink = get_attachment_link( $post->ID ); + break; + default: + $permalink = get_permalink( $post->ID ); + break; + } + + /* in case the bloglinks are relative links add the base url, site specific */ + $baseurl = empty( $url ) ? static::_site_url() : $url; + if ( !strstr( $permalink, $baseurl ) ) { + $permalink = $baseurl . $permalink; + } + + /* collect permalinks */ + $links[ $permalink ] = true; + + } + + $this->backend->taxonomy_links ( $links ); + + /* just in case, reset $post */ + wp_reset_postdata(); + + /* switch back to original site if we navigated away */ + if ( $site !== false ) { + switch_to_blog( $current_blog ); + } } - $this->backend->taxonomy_links ( $links ); - - /* just in case, reset $post */ - wp_reset_postdata(); - - /* switch back to original site if we navigated away */ - if ( $site !== false ) { - switch_to_blog( $current_blog ); + public function getBackend() { + return $this->backend; } - } - public function getBackend() { - return $this->backend; } -} - endif; diff --git a/wp-ffpc.php b/wp-ffpc.php index bd8db82..4a875d2 100644 --- a/wp-ffpc.php +++ b/wp-ffpc.php @@ -3,7 +3,7 @@ Plugin Name: WP-FFPC Plugin URI: https://github.com/petermolnar/wp-ffpc Description: WordPress in-memory full page cache plugin -Version: 1.11.1 +Version: 1.12.0 Author: Peter Molnar Author URI: http://petermolnar.eu/ License: GPLv3 @@ -44,9 +44,9 @@ $wp_ffpc_defaults = array ( 'expire_taxonomy' => 300, 'invalidation_method' => 0, 'prefix_meta' => 'meta-', - 'prefix_meta_mobile' => 'meta-mobile-', + 'prefix_meta_mobile' => 'meta-mobile-', 'prefix_data' => 'data-', - 'prefix_data_mobile' => 'data-mobile-', + 'prefix_data_mobile' => 'data-mobile-', 'charset' => 'utf-8', 'log' => true, 'cache_type' => 'memcached', -- 2.46.2