Campaign.php
2 years ago
Current_Traffic.php
2 years ago
Device.php
2 years ago
Geo.php
2 years ago
Page.php
2 years ago
Page_Author_Archive.php
2 years ago
Page_Date_Archive.php
2 years ago
Page_Home.php
2 years ago
Page_Not_Found.php
2 years ago
Page_Post_Type_Archive.php
2 years ago
Page_Search.php
2 years ago
Page_Singular.php
2 years ago
Page_Term_Archive.php
2 years ago
Page_Virtual.php
2 years ago
Referrer.php
2 years ago
Universal_Model_Columns.php
2 years ago
Visitor.php
2 years ago
WooCommerce_Stats.php
2 years ago
Visitor.php
111 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP\Models; |
| 4 | |
| 5 | use IAWP\Geoposition; |
| 6 | use IAWP\Illuminate_Builder; |
| 7 | use IAWP\Query; |
| 8 | use IAWP\Utils\Request; |
| 9 | use IAWP\Utils\Salt; |
| 10 | /** |
| 11 | * How to use: |
| 12 | * |
| 13 | * Example IP from the Netherlands |
| 14 | * $visitor = new Visitor('92.111.145.208', 'some ua string'); |
| 15 | * |
| 16 | * Example IP from the United States |
| 17 | * $visitor = new Visitor('98.111.145.208', 'some ua string'); |
| 18 | * |
| 19 | * Access visitor token |
| 20 | * $visitor->id(); |
| 21 | * @internal |
| 22 | */ |
| 23 | class Visitor |
| 24 | { |
| 25 | private $id; |
| 26 | private $geoposition; |
| 27 | private $current_session; |
| 28 | /** |
| 29 | * New instances should be created with a string ip address |
| 30 | * |
| 31 | * @param string $ip |
| 32 | * @param string $user_agent |
| 33 | */ |
| 34 | public function __construct(string $ip, string $user_agent) |
| 35 | { |
| 36 | $this->id = $this->fetch_visitor_id($this->calculate_hash($ip, $user_agent)); |
| 37 | $this->geoposition = new Geoposition($ip); |
| 38 | $this->current_session = $this->fetch_current_session(); |
| 39 | } |
| 40 | public function geoposition() : Geoposition |
| 41 | { |
| 42 | return $this->geoposition; |
| 43 | } |
| 44 | public function has_recorded_session() : bool |
| 45 | { |
| 46 | return \is_object($this->current_session); |
| 47 | } |
| 48 | public function most_recent_session_id() : ?int |
| 49 | { |
| 50 | if ($this->has_recorded_session() && \is_int($this->current_session->session_id)) { |
| 51 | return $this->current_session->session_id; |
| 52 | } else { |
| 53 | return null; |
| 54 | } |
| 55 | } |
| 56 | public function most_recent_initial_view_id() : ?int |
| 57 | { |
| 58 | if ($this->has_recorded_session() && \is_int($this->current_session->initial_view_id)) { |
| 59 | return $this->current_session->initial_view_id; |
| 60 | } else { |
| 61 | return null; |
| 62 | } |
| 63 | } |
| 64 | public function most_recent_view_id() : ?int |
| 65 | { |
| 66 | if (!$this->has_recorded_session()) { |
| 67 | return null; |
| 68 | } |
| 69 | if (\is_int($this->current_session->final_view_id)) { |
| 70 | return $this->current_session->final_view_id; |
| 71 | } |
| 72 | return $this->current_session->initial_view_id; |
| 73 | } |
| 74 | /** |
| 75 | * Return the database id for a visitor |
| 76 | * |
| 77 | * @return string |
| 78 | */ |
| 79 | public function id() : string |
| 80 | { |
| 81 | return $this->id; |
| 82 | } |
| 83 | /** |
| 84 | * @param string $ip |
| 85 | * @param string $user_agent |
| 86 | * @return string |
| 87 | */ |
| 88 | private function calculate_hash(string $ip, string $user_agent) : string |
| 89 | { |
| 90 | $salt = Salt::visitor_token_salt(); |
| 91 | $result = $salt . $ip . $user_agent; |
| 92 | return \md5($result); |
| 93 | } |
| 94 | private function fetch_visitor_id(string $hash) : int |
| 95 | { |
| 96 | $visitors_table = Query::get_table_name(Query::VISITORS); |
| 97 | Illuminate_Builder::get_builder()->from($visitors_table)->insertOrIgnore([['hash' => $hash]]); |
| 98 | return Illuminate_Builder::get_builder()->from($visitors_table)->where('hash', '=', $hash)->value('visitor_id'); |
| 99 | } |
| 100 | private function fetch_current_session() |
| 101 | { |
| 102 | $sessions_table = Query::get_table_name(Query::SESSIONS); |
| 103 | $session = Illuminate_Builder::get_builder()->from($sessions_table, 'sessions')->selectRaw('IFNULL(ended_at, created_at) AS latest_view_at')->selectRaw('sessions.*')->where('visitor_id', '=', $this->id)->havingRaw('latest_view_at > DATE_SUB(UTC_TIMESTAMP(), INTERVAL 30 MINUTE)')->orderBy('latest_view_at', 'DESC')->first(); |
| 104 | return $session; |
| 105 | } |
| 106 | public static function fetch_current_visitor() : self |
| 107 | { |
| 108 | return new \IAWP\Models\Visitor(Request::ip(), Request::user_agent()); |
| 109 | } |
| 110 | } |
| 111 |