Campaign.php
10 months ago
Campaign_Landing_Page.php
9 months ago
Campaign_UTM_Campaign.php
9 months ago
Campaign_UTM_Medium.php
9 months ago
Campaign_UTM_Source.php
9 months ago
ClickWhale_Link_Page.php
1 year ago
Current_Traffic.php
2 years ago
Device.php
10 months ago
Form.php
1 year ago
Geo.php
10 months ago
Journey.php
5 months ago
Link.php
8 months ago
Link_Pattern.php
10 months ago
Model.php
6 months ago
Page.php
10 months 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
1 year ago
Page_Post_Type_Archive.php
1 year ago
Page_Search.php
2 years ago
Page_Singular.php
1 year ago
Page_Term_Archive.php
2 years ago
Page_Virtual.php
1 year ago
Referrer.php
6 months ago
Referrer_Type.php
9 months ago
Universal_Model_Columns.php
1 year ago
Visitor.php
9 months ago
Visitor.php
122 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_by_hash($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 | $session_id = \IAWPSCOPED\iawp_intify($this->current_session->session_id); |
| 51 | if ($this->has_recorded_session() && \is_int($session_id)) { |
| 52 | return $session_id; |
| 53 | } else { |
| 54 | return null; |
| 55 | } |
| 56 | } |
| 57 | public function most_recent_initial_view_id() : ?int |
| 58 | { |
| 59 | $initial_view_id = \IAWPSCOPED\iawp_intify($this->current_session->initial_view_id); |
| 60 | if ($this->has_recorded_session() && \is_int($initial_view_id)) { |
| 61 | return $initial_view_id; |
| 62 | } else { |
| 63 | return null; |
| 64 | } |
| 65 | } |
| 66 | public function most_recent_final_view_id() : ?int |
| 67 | { |
| 68 | $final_view_id = \IAWPSCOPED\iawp_intify($this->current_session->final_view_id); |
| 69 | if ($this->has_recorded_session() && \is_int($final_view_id)) { |
| 70 | return $final_view_id; |
| 71 | } else { |
| 72 | return null; |
| 73 | } |
| 74 | } |
| 75 | public function most_recent_view_id() : ?int |
| 76 | { |
| 77 | return $this->most_recent_final_view_id() ?? $this->most_recent_initial_view_id(); |
| 78 | } |
| 79 | /** |
| 80 | * Return the database id for a visitor |
| 81 | * |
| 82 | * @return string |
| 83 | */ |
| 84 | public function id() : string |
| 85 | { |
| 86 | return $this->id; |
| 87 | } |
| 88 | public function is_first_session() : bool |
| 89 | { |
| 90 | $sessions_table = Query::get_table_name(Query::SESSIONS); |
| 91 | return Illuminate_Builder::new()->select('session_id')->from($sessions_table, 'sessions')->where('visitor_id', '=', $this->id)->doesntExist(); |
| 92 | } |
| 93 | /** |
| 94 | * @param string $ip |
| 95 | * @param string $user_agent |
| 96 | * @return string |
| 97 | */ |
| 98 | private function calculate_hash(string $ip, string $user_agent) : string |
| 99 | { |
| 100 | $salt = Salt::visitor_token_salt(); |
| 101 | $result = $salt . $ip . $user_agent; |
| 102 | return \md5($result); |
| 103 | } |
| 104 | private function fetch_current_session() |
| 105 | { |
| 106 | $sessions_table = Query::get_table_name(Query::SESSIONS); |
| 107 | $session = Illuminate_Builder::new()->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(); |
| 108 | return $session; |
| 109 | } |
| 110 | public static function fetch_visitor_id_by_hash(string $hash) : int |
| 111 | { |
| 112 | $visitors_table = Query::get_table_name(Query::VISITORS); |
| 113 | Illuminate_Builder::new()->from($visitors_table)->insertOrIgnore([['hash' => $hash]]); |
| 114 | $id = Illuminate_Builder::new()->from($visitors_table)->where('hash', '=', $hash)->value('visitor_id'); |
| 115 | return (int) $id; |
| 116 | } |
| 117 | public static function fetch_current_visitor() : self |
| 118 | { |
| 119 | return new \IAWP\Models\Visitor(Request::ip(), Request::user_agent()); |
| 120 | } |
| 121 | } |
| 122 |