wfPage.php
264 lines
| 1 | <?php |
| 2 | |
| 3 | class wfPage { |
| 4 | const PAGE_DASHBOARD = 'dashboard'; |
| 5 | const PAGE_DASHBOARD_OPTIONS = 'dashboard-options'; |
| 6 | const PAGE_FIREWALL = 'firewall'; |
| 7 | const PAGE_FIREWALL_OPTIONS = 'firewall-options'; |
| 8 | const PAGE_BLOCKING = 'blocking'; |
| 9 | const PAGE_BLOCKING_OPTIONS = 'blocking-options'; |
| 10 | const PAGE_SCAN = 'scan'; |
| 11 | const PAGE_SCAN_OPTIONS = 'scan-options'; |
| 12 | const PAGE_TOOLS_2FA = 'tools-2fa'; |
| 13 | const PAGE_TOOLS_LIVE_TRAFFIC = 'tools-2fa'; |
| 14 | const PAGE_TOOLS_WHOIS = 'tools-whois'; |
| 15 | const PAGE_TOOLS_IMPORT_EXPORT = 'tools-import-export'; |
| 16 | const PAGE_TOOLS_DIAGNOSTICS = 'tools-diagnostics'; |
| 17 | const PAGE_SUPPORT = 'support'; |
| 18 | |
| 19 | /** @var string */ |
| 20 | private $_identifier; |
| 21 | |
| 22 | /** |
| 23 | * Provides validation for a user-provided page identifier. |
| 24 | * |
| 25 | * @param string $identifier |
| 26 | * @return bool |
| 27 | */ |
| 28 | public static function isValidPage($identifier) { |
| 29 | switch ($identifier) { |
| 30 | case self::PAGE_DASHBOARD: |
| 31 | case self::PAGE_DASHBOARD_OPTIONS: |
| 32 | case self::PAGE_FIREWALL: |
| 33 | case self::PAGE_FIREWALL_OPTIONS: |
| 34 | case self::PAGE_BLOCKING: |
| 35 | case self::PAGE_BLOCKING_OPTIONS: |
| 36 | case self::PAGE_SCAN: |
| 37 | case self::PAGE_SCAN_OPTIONS: |
| 38 | case self::PAGE_TOOLS_2FA: |
| 39 | case self::PAGE_TOOLS_LIVE_TRAFFIC: |
| 40 | case self::PAGE_TOOLS_IMPORT_EXPORT: |
| 41 | case self::PAGE_TOOLS_WHOIS: |
| 42 | case self::PAGE_TOOLS_DIAGNOSTICS: |
| 43 | case self::PAGE_SUPPORT: |
| 44 | return true; |
| 45 | } |
| 46 | return false; |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * Convenience function for returning the user-displayable label for the given page. |
| 51 | * |
| 52 | * @param string $identifier |
| 53 | * @return bool|string |
| 54 | */ |
| 55 | public static function pageLabel($identifier) { |
| 56 | $page = new wfPage($identifier); |
| 57 | return $page->label(); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Convenience function for returning the canonical URL for the given page. |
| 62 | * |
| 63 | * @param string $identifier |
| 64 | * @param string|bool $source The source page identifier to append to the URL if wanted. |
| 65 | * @return string |
| 66 | */ |
| 67 | public static function pageURL($identifier, $source = false) { |
| 68 | $page = new wfPage($identifier); |
| 69 | return $page->url($source); |
| 70 | } |
| 71 | |
| 72 | public function __construct($identifier) { |
| 73 | $this->_identifier = $identifier; |
| 74 | } |
| 75 | |
| 76 | public function __get($key) { |
| 77 | switch ($key) { |
| 78 | case 'identifier': |
| 79 | return $this->_identifier; |
| 80 | } |
| 81 | |
| 82 | throw new OutOfBoundsException("{$key} is not a valid property"); |
| 83 | } |
| 84 | |
| 85 | public function __isset($key) { |
| 86 | switch ($key) { |
| 87 | case 'identifier': |
| 88 | return true; |
| 89 | } |
| 90 | return false; |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * Returns the user-displayable label for the page. |
| 95 | * |
| 96 | * @return bool|string |
| 97 | */ |
| 98 | public function label() { |
| 99 | switch ($this->identifier) { |
| 100 | case self::PAGE_DASHBOARD: |
| 101 | return __('Dashboard', 'wordfence'); |
| 102 | case self::PAGE_DASHBOARD_OPTIONS: |
| 103 | return __('Global Options', 'wordfence'); |
| 104 | case self::PAGE_FIREWALL: |
| 105 | return __('Firewall', 'wordfence'); |
| 106 | case self::PAGE_FIREWALL_OPTIONS: |
| 107 | return __('Firewall Options', 'wordfence'); |
| 108 | case self::PAGE_BLOCKING: |
| 109 | return __('Blocking', 'wordfence'); |
| 110 | case self::PAGE_BLOCKING_OPTIONS: |
| 111 | return __('Blocking Options', 'wordfence'); |
| 112 | case self::PAGE_SCAN: |
| 113 | return __('Scan', 'wordfence'); |
| 114 | case self::PAGE_SCAN_OPTIONS: |
| 115 | return __('Scan Options', 'wordfence'); |
| 116 | case self::PAGE_TOOLS_2FA: |
| 117 | return __('Two-Factor Authentication', 'wordfence'); |
| 118 | case self::PAGE_TOOLS_LIVE_TRAFFIC: |
| 119 | return __('Live Traffic', 'wordfence'); |
| 120 | case self::PAGE_TOOLS_IMPORT_EXPORT: |
| 121 | return __('Import/Export Options', 'wordfence'); |
| 122 | case self::PAGE_TOOLS_WHOIS: |
| 123 | return __('Whois Lookup', 'wordfence'); |
| 124 | case self::PAGE_TOOLS_DIAGNOSTICS: |
| 125 | return __('Diagnostics', 'wordfence'); |
| 126 | case self::PAGE_SUPPORT: |
| 127 | return __('Support', 'wordfence'); |
| 128 | } |
| 129 | |
| 130 | return false; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Returns the canonical URL for the page. |
| 135 | * |
| 136 | * @param string|bool $source The source page identifier to append to the URL if wanted. |
| 137 | * @return string |
| 138 | */ |
| 139 | public function url($source = false) { |
| 140 | $page = ''; |
| 141 | $subpage = ''; |
| 142 | $hash = ''; |
| 143 | switch ($this->identifier) { |
| 144 | case self::PAGE_DASHBOARD: |
| 145 | $page = 'Wordfence'; |
| 146 | break; |
| 147 | case self::PAGE_DASHBOARD_OPTIONS: |
| 148 | $page = 'Wordfence'; |
| 149 | $subpage = 'global_options'; |
| 150 | break; |
| 151 | case self::PAGE_FIREWALL: |
| 152 | $page = 'WordfenceWAF'; |
| 153 | break; |
| 154 | case self::PAGE_FIREWALL_OPTIONS: |
| 155 | $page = 'WordfenceWAF'; |
| 156 | $subpage = 'waf_options'; |
| 157 | break; |
| 158 | case self::PAGE_BLOCKING: |
| 159 | $page = 'WordfenceWAF'; |
| 160 | $hash = '#top#blocking'; |
| 161 | break; |
| 162 | case self::PAGE_BLOCKING_OPTIONS: |
| 163 | $page = 'WordfenceWAF'; |
| 164 | $subpage = 'blocking_options'; |
| 165 | break; |
| 166 | case self::PAGE_SCAN: |
| 167 | $page = 'WordfenceScan'; |
| 168 | break; |
| 169 | case self::PAGE_SCAN_OPTIONS: |
| 170 | $page = 'WordfenceScan'; |
| 171 | $subpage = 'scan_options'; |
| 172 | break; |
| 173 | case self::PAGE_TOOLS_2FA: |
| 174 | $page = 'WordfenceTools'; |
| 175 | $subpage = 'twofactor'; |
| 176 | break; |
| 177 | case self::PAGE_TOOLS_LIVE_TRAFFIC: |
| 178 | $page = 'WordfenceTools'; |
| 179 | $subpage = 'livetraffic'; |
| 180 | break; |
| 181 | case self::PAGE_TOOLS_IMPORT_EXPORT: |
| 182 | $page = 'WordfenceTools'; |
| 183 | $subpage = 'importexport'; |
| 184 | break; |
| 185 | case self::PAGE_TOOLS_WHOIS: |
| 186 | $page = 'WordfenceTools'; |
| 187 | $subpage = 'whois'; |
| 188 | break; |
| 189 | case self::PAGE_TOOLS_DIAGNOSTICS: |
| 190 | $page = 'WordfenceTools'; |
| 191 | $subpage = 'diagnostics'; |
| 192 | break; |
| 193 | case self::PAGE_SUPPORT: |
| 194 | $page = 'WordfenceSupport'; |
| 195 | break; |
| 196 | } |
| 197 | |
| 198 | $baseURL = 'admin.php?'; |
| 199 | $baseURL .= 'page=' . rawurlencode($page); |
| 200 | if (!empty($subpage)) { $baseURL .= '&subpage=' . rawurlencode($subpage); } |
| 201 | if (self::isValidPage($source)) { $baseURL .= '&source=' . rawurlencode($source); } |
| 202 | if (!empty($hash)) { $baseURL .= $this->_hashURLEncode($hash); } |
| 203 | if (function_exists('network_admin_url') && is_multisite()) { |
| 204 | return network_admin_url($baseURL); |
| 205 | } |
| 206 | |
| 207 | return admin_url($baseURL); |
| 208 | } |
| 209 | |
| 210 | /** |
| 211 | * Splits a URI hash component and URL-encodes its members. |
| 212 | * |
| 213 | * @param string $hash |
| 214 | * @return string |
| 215 | */ |
| 216 | private function _hashURLEncode($hash) { |
| 217 | $components = explode('#', $hash); |
| 218 | foreach ($components as &$c) { |
| 219 | $c = rawurlencode($c); |
| 220 | } |
| 221 | return implode('#', $components); |
| 222 | } |
| 223 | |
| 224 | /** |
| 225 | * Returns an ordered array of the pages required to reach this page, this page being the last entry in the array. |
| 226 | * |
| 227 | * @return array |
| 228 | */ |
| 229 | public function breadcrumbs() { |
| 230 | switch ($this->identifier) { |
| 231 | case self::PAGE_DASHBOARD: |
| 232 | return array($this); |
| 233 | case self::PAGE_DASHBOARD_OPTIONS: |
| 234 | return array(new wfPage(wfPage::PAGE_DASHBOARD), $this); |
| 235 | case self::PAGE_FIREWALL: |
| 236 | return array($this); |
| 237 | case self::PAGE_FIREWALL_OPTIONS: |
| 238 | return array(new wfPage(wfPage::PAGE_FIREWALL), $this); |
| 239 | case self::PAGE_BLOCKING: |
| 240 | return array($this); |
| 241 | case self::PAGE_BLOCKING_OPTIONS: |
| 242 | return array(new wfPage(wfPage::PAGE_BLOCKING), $this); |
| 243 | case self::PAGE_SCAN: |
| 244 | return array($this); |
| 245 | case self::PAGE_SCAN_OPTIONS: |
| 246 | return array(new wfPage(wfPage::PAGE_SCAN), $this); |
| 247 | case self::PAGE_TOOLS_2FA: |
| 248 | return array($this); |
| 249 | case self::PAGE_TOOLS_LIVE_TRAFFIC: |
| 250 | return array($this); |
| 251 | case self::PAGE_TOOLS_IMPORT_EXPORT: |
| 252 | return array($this); |
| 253 | case self::PAGE_TOOLS_WHOIS: |
| 254 | return array($this); |
| 255 | case self::PAGE_TOOLS_DIAGNOSTICS: |
| 256 | return array($this); |
| 257 | case self::PAGE_SUPPORT: |
| 258 | return array($this); |
| 259 | } |
| 260 | |
| 261 | return array(); |
| 262 | } |
| 263 | } |
| 264 |