campaign.php
3 years ago
current_traffic.php
3 years ago
geo.php
3 years ago
page.php
3 years ago
page_author_archive.php
3 years ago
page_date_archive.php
3 years ago
page_home.php
3 years ago
page_not_found.php
3 years ago
page_post_type_archive.php
3 years ago
page_search.php
3 years ago
page_singular.php
3 years ago
page_term_archive.php
3 years ago
referrer.php
3 years ago
view_stats.php
3 years ago
visitor.php
3 years ago
visitor.php
132 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP; |
| 4 | |
| 5 | /** |
| 6 | * How to use: |
| 7 | * |
| 8 | * Example IP from the Netherlands |
| 9 | * $visitor = new Visitor('92.111.145.208', 'some ua string'); |
| 10 | * |
| 11 | * Example IP from the United States |
| 12 | * $visitor = new Visitor('98.111.145.208', 'some ua string'); |
| 13 | * |
| 14 | * Access visitor token |
| 15 | * $visitor->token(); |
| 16 | * |
| 17 | * Access geo data |
| 18 | * $visitor->country_code() |
| 19 | * $visitor->city() |
| 20 | * $visitor->subdivision() |
| 21 | * $visitor->country() |
| 22 | * $visitor->continent() |
| 23 | */ |
| 24 | class Visitor |
| 25 | { |
| 26 | private $token; |
| 27 | private $geo = null; |
| 28 | |
| 29 | /** |
| 30 | * New instances should be created with a string ip address |
| 31 | * |
| 32 | * @param string $ip |
| 33 | * @param string $user_agent |
| 34 | */ |
| 35 | public function __construct(string $ip, string $user_agent) |
| 36 | { |
| 37 | $this->token = self::calculate_token($ip, $user_agent); |
| 38 | |
| 39 | $geo_database = new Geo_Database(); |
| 40 | $this->geo = $geo_database->ip_to_geo($ip); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * @param string $ip |
| 45 | * @param string $user_agent |
| 46 | * @return string |
| 47 | */ |
| 48 | private function calculate_token(string $ip, string $user_agent): string |
| 49 | { |
| 50 | $salt = Salt::visitor_token_salt(); |
| 51 | $result = $salt . $ip . $user_agent; |
| 52 | |
| 53 | return md5($result); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Return a token unique for a given visitor |
| 58 | * |
| 59 | * @return string |
| 60 | */ |
| 61 | public function token(): string |
| 62 | { |
| 63 | return $this->token; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Return an ISO country code |
| 68 | * |
| 69 | * @return string|null |
| 70 | */ |
| 71 | public function country_code(): ?string |
| 72 | { |
| 73 | if (isset($this->geo['country']['iso_code'])) { |
| 74 | return $this->geo['country']['iso_code']; |
| 75 | } else { |
| 76 | return null; |
| 77 | } |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Return an English city name |
| 82 | * |
| 83 | * @return string|null |
| 84 | */ |
| 85 | public function city(): ?string |
| 86 | { |
| 87 | if (isset($this->geo['city']['names']['en'])) { |
| 88 | return $this->geo['city']['names']['en']; |
| 89 | } else { |
| 90 | return null; |
| 91 | } |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Return an English subdivision name |
| 96 | * |
| 97 | * @return string|null |
| 98 | */ |
| 99 | public function subdivision(): ?string |
| 100 | { |
| 101 | if (isset($this->geo['subdivisions'][0]['names']['en'])) { |
| 102 | return $this->geo['subdivisions'][0]['names']['en']; |
| 103 | } else { |
| 104 | return null; |
| 105 | } |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * @return string|null |
| 110 | */ |
| 111 | public function country(): ?string |
| 112 | { |
| 113 | if (isset($this->geo['country']['names']['en'])) { |
| 114 | return $this->geo['country']['names']['en']; |
| 115 | } else { |
| 116 | return null; |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | /** |
| 121 | * @return string|null |
| 122 | */ |
| 123 | public function continent(): ?string |
| 124 | { |
| 125 | if (isset($this->geo['continent']['names']['en'])) { |
| 126 | return $this->geo['continent']['names']['en']; |
| 127 | } else { |
| 128 | return null; |
| 129 | } |
| 130 | } |
| 131 | } |
| 132 |