AJAX
2 years ago
Date_Range
2 years ago
Interval
2 years ago
Menu_Bar_Stats
2 years ago
Migrations
2 years ago
Models
2 years ago
Public_API
2 years ago
Rows
2 years ago
Statistics
2 years ago
Tables
2 years ago
Utils
2 years ago
Campaign_Builder.php
2 years ago
Capability_Manager.php
2 years ago
Chart.php
2 years ago
Chart_Geo.php
2 years ago
Cron_Manager.php
2 years ago
Current_Traffic_Finder.php
2 years ago
Dashboard_Options.php
2 years ago
Dashboard_Widget.php
2 years ago
Database_Manager.php
2 years ago
Email_Chart.php
2 years ago
Email_Reports.php
2 years ago
Empty_Report_Option.php
2 years ago
Env.php
2 years ago
Filters.php
2 years ago
Geo_Database_Background_Job.php
2 years ago
Geo_Database_Manager.php
2 years ago
Geoposition.php
2 years ago
Icon_Directory.php
2 years ago
Icon_Directory_Factory.php
2 years ago
Illuminate_Builder.php
2 years ago
Independent_Analytics.php
2 years ago
Interrupt.php
2 years ago
Known_Referrers.php
2 years ago
Plugin_Conflict_Detector.php
2 years ago
Query.php
2 years ago
Quick_Stats.php
2 years ago
REST_API.php
2 years ago
Real_Time.php
2 years ago
Report.php
2 years ago
Report_Finder.php
2 years ago
Report_Options_Parser.php
2 years ago
Resource_Identifier.php
2 years ago
Settings.php
2 years ago
Sort_Configuration.php
2 years ago
Track_Resource_Changes.php
2 years ago
View.php
2 years ago
View_Counter.php
2 years ago
Visitors_Over_Time_Finder.php
2 years ago
WP_Option_Cache_Bust.php
2 years ago
WooCommerce_Order.php
2 years ago
WooCommerce_Referrer_Meta_Box.php
2 years ago
View.php
273 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP_SCOPED\IAWP; |
| 4 | |
| 5 | use IAWP_SCOPED\IAWP\Models\Page; |
| 6 | use IAWP_SCOPED\IAWP\Models\Visitor; |
| 7 | use IAWP_SCOPED\IAWP\Utils\Device; |
| 8 | use IAWP_SCOPED\IAWP\Utils\String_Util; |
| 9 | use IAWP_SCOPED\IAWP\Utils\URL; |
| 10 | /** @internal */ |
| 11 | class View |
| 12 | { |
| 13 | private $payload; |
| 14 | private $referrer_url; |
| 15 | private $visitor; |
| 16 | private $campaign_fields; |
| 17 | private $viewed_at; |
| 18 | private $resource; |
| 19 | private $session; |
| 20 | /** |
| 21 | * @param array $payload |
| 22 | * @param string|null $referrer_url |
| 23 | * @param Visitor $visitor |
| 24 | * @param array $campaign_fields |
| 25 | * @param \DateTime|null $viewed_at |
| 26 | */ |
| 27 | public function __construct(array $payload, ?string $referrer_url, Visitor $visitor, array $campaign_fields, ?\DateTime $viewed_at = null) |
| 28 | { |
| 29 | $this->payload = $payload; |
| 30 | $this->referrer_url = \is_null($referrer_url) ? '' : \trim($referrer_url); |
| 31 | $this->visitor = $visitor; |
| 32 | $this->campaign_fields = $campaign_fields; |
| 33 | $this->viewed_at = $viewed_at instanceof \DateTime ? $viewed_at : new \DateTime(); |
| 34 | $this->resource = $this->fetch_or_create_resource(); |
| 35 | $this->session = $this->fetch_or_create_session(); |
| 36 | $view_id = $this->create_view(); |
| 37 | $this->link_with_previous_view($view_id); |
| 38 | $this->set_session_total_views(); |
| 39 | $this->set_sessions_initial_view($view_id); |
| 40 | $this->set_sessions_final_view($view_id); |
| 41 | } |
| 42 | /** |
| 43 | * @return int ID of newly created session |
| 44 | */ |
| 45 | public function create_session() : int |
| 46 | { |
| 47 | $sessions_table = Query::get_table_name(Query::SESSIONS); |
| 48 | return Illuminate_Builder::get_builder()->from($sessions_table)->insertGetId(['visitor_id' => $this->visitor->id(), 'referrer_id' => $this->fetch_or_create_referrer(), 'country_id' => $this->fetch_or_create_country(), 'city_id' => $this->fetch_or_create_city(), 'campaign_id' => $this->get_campaign(), 'device_type_id' => Device::getInstance()->type_id(), 'device_os_id' => Device::getInstance()->os_id(), 'device_browser_id' => Device::getInstance()->browser_id(), 'created_at' => $this->viewed_at()]); |
| 49 | } |
| 50 | /** |
| 51 | * Fetch the last view, if any. |
| 52 | * |
| 53 | * @return int|null |
| 54 | */ |
| 55 | public function fetch_last_viewed_resource() : ?int |
| 56 | { |
| 57 | global $wpdb; |
| 58 | $views_table = Query::get_table_name(Query::VIEWS); |
| 59 | $session = Query::query('sessions/get_current_session', ['visitor_id' => $this->visitor->id()])->row(); |
| 60 | if (\is_null($session)) { |
| 61 | return null; |
| 62 | } |
| 63 | $view = $wpdb->get_row($wpdb->prepare("\n SELECT * FROM {$views_table} WHERE session_id = %d ORDER BY viewed_at DESC LIMIT 1\n ", $session->session_id)); |
| 64 | if (\is_null($view)) { |
| 65 | return null; |
| 66 | } |
| 67 | return $view->resource_id; |
| 68 | } |
| 69 | public function fetch_or_create_country() : ?int |
| 70 | { |
| 71 | if (!$this->visitor->geoposition()->valid_location()) { |
| 72 | return null; |
| 73 | } |
| 74 | Query::query('create_country', ['country_code' => $this->visitor->geoposition()->country_code(), 'country' => $this->visitor->geoposition()->country(), 'continent' => $this->visitor->geoposition()->continent()]); |
| 75 | $country = Query::query('get_country', ['country_code' => $this->visitor->geoposition()->country_code(), 'country' => $this->visitor->geoposition()->country(), 'continent' => $this->visitor->geoposition()->continent()])->row(); |
| 76 | if (\is_null($country)) { |
| 77 | return null; |
| 78 | } |
| 79 | return $country->country_id; |
| 80 | } |
| 81 | public function fetch_or_create_city() : ?int |
| 82 | { |
| 83 | if (!$this->visitor->geoposition()->valid_location()) { |
| 84 | return null; |
| 85 | } |
| 86 | $country_id = $this->fetch_or_create_country(); |
| 87 | $cities_table = Query::get_table_name(Query::CITIES); |
| 88 | $city_id = Illuminate_Builder::get_builder()->from($cities_table)->where('country_id', $country_id)->where('subdivision', $this->visitor->geoposition()->subdivision())->where('city', $this->visitor->geoposition()->city())->value('city_id'); |
| 89 | if (!\is_null($city_id)) { |
| 90 | return $city_id; |
| 91 | } |
| 92 | Illuminate_Builder::get_builder()->from($cities_table)->insertOrIgnore(['country_id' => $country_id, 'subdivision' => $this->visitor->geoposition()->subdivision(), 'city' => $this->visitor->geoposition()->city()]); |
| 93 | return Illuminate_Builder::get_builder()->from($cities_table)->where('country_id', $country_id)->where('subdivision', $this->visitor->geoposition()->subdivision())->where('city', $this->visitor->geoposition()->city())->value('city_id'); |
| 94 | } |
| 95 | private function viewed_at() : string |
| 96 | { |
| 97 | return $this->viewed_at->format('Y-m-d\\TH:i:s'); |
| 98 | } |
| 99 | private function link_with_previous_view($view_id) : void |
| 100 | { |
| 101 | global $wpdb; |
| 102 | $views_tables = Query::get_table_name(Query::VIEWS); |
| 103 | $session = Query::query('sessions/get_session', ['session_id' => $this->session])->row(); |
| 104 | if (\is_null($session)) { |
| 105 | return; |
| 106 | } |
| 107 | $final_view_id = $session->final_view_id; |
| 108 | $initial_view_id = $session->initial_view_id; |
| 109 | if (!\is_null($final_view_id)) { |
| 110 | $wpdb->update($views_tables, ['next_view_id' => $view_id, 'next_viewed_at' => $this->viewed_at()], ['id' => $final_view_id]); |
| 111 | } elseif (!\is_null($initial_view_id)) { |
| 112 | $wpdb->update($views_tables, ['next_view_id' => $view_id, 'next_viewed_at' => $this->viewed_at()], ['id' => $initial_view_id]); |
| 113 | } |
| 114 | } |
| 115 | private function set_session_total_views() |
| 116 | { |
| 117 | global $wpdb; |
| 118 | $sessions_table = Query::get_table_name(Query::SESSIONS); |
| 119 | $views_table = Query::get_table_name(Query::VIEWS); |
| 120 | $wpdb->query($wpdb->prepare("\n UPDATE {$sessions_table} AS sessions\n LEFT JOIN (\n SELECT\n session_id,\n COUNT(*) AS view_count\n FROM\n {$views_table} AS views\n WHERE\n views.session_id = %d\n GROUP BY\n session_id) AS view_counts ON sessions.session_id = view_counts.session_id\n SET\n sessions.total_views = COALESCE(view_counts.view_count, 0)\n WHERE sessions.session_id = %d\n ", $this->session, $this->session)); |
| 121 | } |
| 122 | private function set_sessions_initial_view(int $view_id) |
| 123 | { |
| 124 | global $wpdb; |
| 125 | $sessions_table = Query::get_table_name(Query::SESSIONS); |
| 126 | $wpdb->query($wpdb->prepare("UPDATE {$sessions_table} SET initial_view_id = %d WHERE session_id = %d AND initial_view_id IS NULL", $view_id, $this->session)); |
| 127 | } |
| 128 | private function set_sessions_final_view(int $view_id) |
| 129 | { |
| 130 | global $wpdb; |
| 131 | $sessions_table = Query::get_table_name(Query::SESSIONS); |
| 132 | $wpdb->query($wpdb->prepare("\n UPDATE {$sessions_table} AS sessions\n SET\n sessions.final_view_id = %d,\n sessions.ended_at = %s\n WHERE sessions.session_id = %d AND sessions.initial_view_id IS NOT NULL AND sessions.initial_view_id != %d\n ", $view_id, $this->viewed_at(), $this->session, $view_id)); |
| 133 | } |
| 134 | private function create_view() : ?int |
| 135 | { |
| 136 | return Query::query('create_view', ['resource_id' => $this->resource->id(), 'viewed_at' => $this->viewed_at(), 'page' => $this->payload['page'], 'session_id' => $this->session])->last_inserted_id(); |
| 137 | } |
| 138 | private function fetch_resource() |
| 139 | { |
| 140 | global $wpdb; |
| 141 | $resources_table = Query::get_table_name(Query::RESOURCES); |
| 142 | $query = ''; |
| 143 | $payload_copy = \array_merge($this->payload); |
| 144 | unset($payload_copy['page']); |
| 145 | switch ($payload_copy['resource']) { |
| 146 | case 'singular': |
| 147 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s AND singular_id = %d", $payload_copy['resource'], $payload_copy['singular_id']); |
| 148 | break; |
| 149 | case 'author_archive': |
| 150 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s AND author_id = %d", $payload_copy['resource'], $payload_copy['author_id']); |
| 151 | break; |
| 152 | case 'date_archive': |
| 153 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s AND date_archive = %s", $payload_copy['resource'], $payload_copy['date_archive']); |
| 154 | break; |
| 155 | case 'post_type_archive': |
| 156 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s AND post_type = %s", $payload_copy['resource'], $payload_copy['post_type']); |
| 157 | break; |
| 158 | case 'term_archive': |
| 159 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s AND term_id = %s", $payload_copy['resource'], $payload_copy['term_id']); |
| 160 | break; |
| 161 | case 'search': |
| 162 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s AND search_query = %s", $payload_copy['resource'], $payload_copy['search_query']); |
| 163 | break; |
| 164 | case 'home': |
| 165 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s ", $payload_copy['resource']); |
| 166 | break; |
| 167 | case '404': |
| 168 | $query = $wpdb->prepare("SELECT * FROM {$resources_table} WHERE resource = %s AND not_found_url = %s", $payload_copy['resource'], $payload_copy['not_found_url']); |
| 169 | break; |
| 170 | } |
| 171 | $resource = $wpdb->get_row($query); |
| 172 | if (\is_null($resource)) { |
| 173 | return null; |
| 174 | } |
| 175 | return $resource; |
| 176 | } |
| 177 | private function fetch_or_create_resource() : Page |
| 178 | { |
| 179 | global $wpdb; |
| 180 | $resources_table = Query::get_table_name(Query::RESOURCES); |
| 181 | $resource = $this->fetch_resource(); |
| 182 | if (\is_null($resource)) { |
| 183 | $payload_copy = \array_merge($this->payload); |
| 184 | unset($payload_copy['page']); |
| 185 | $wpdb->insert($resources_table, $payload_copy); |
| 186 | $resource = $this->fetch_resource(); |
| 187 | } |
| 188 | $page = Page::from_row($resource); |
| 189 | $page->update_cache(); |
| 190 | return $page; |
| 191 | } |
| 192 | /** |
| 193 | * @return int|null ID of the session that should be used for this view |
| 194 | */ |
| 195 | private function fetch_or_create_session() : ?int |
| 196 | { |
| 197 | $session = Query::query('sessions/get_current_session', ['visitor_id' => $this->visitor->id()])->row(); |
| 198 | if (\is_null($session)) { |
| 199 | return $this->create_session(); |
| 200 | } |
| 201 | $same_referrer = $this->fetch_or_create_referrer() === $session->referrer_id; |
| 202 | $same_resource = \intval($this->fetch_resource()->id) === $this->fetch_last_viewed_resource(); |
| 203 | $same_as_previous_view = $same_referrer && $same_resource; |
| 204 | // The goal here is to prevent a page refresh from creating another session |
| 205 | if (!$this->is_internal_referrer($this->referrer_url) && !$same_as_previous_view) { |
| 206 | return $this->create_session(); |
| 207 | } |
| 208 | return $session->session_id; |
| 209 | } |
| 210 | /** |
| 211 | * @param string|null $referrer_url |
| 212 | * |
| 213 | * @return bool |
| 214 | */ |
| 215 | private function is_internal_referrer(?string $referrer_url) : bool |
| 216 | { |
| 217 | return !empty($referrer_url) && String_Util::str_starts_with(\strtolower($referrer_url), \strtolower(\site_url())); |
| 218 | } |
| 219 | private function fetch_referrer(array $referrer) : int |
| 220 | { |
| 221 | $referrers_table = Query::get_table_name(Query::REFERRERS); |
| 222 | $id = Illuminate_Builder::get_builder()->select('id')->from($referrers_table)->where('domain', '=', $referrer['domain'])->value('id'); |
| 223 | if (\is_null($id)) { |
| 224 | $id = Illuminate_Builder::get_builder()->from($referrers_table)->insertGetId(['domain' => $referrer['domain'], 'type' => $referrer['type'], 'referrer' => $referrer['referrer']]); |
| 225 | } |
| 226 | return $id; |
| 227 | } |
| 228 | private function fetch_or_create_referrer() : int |
| 229 | { |
| 230 | $url = new URL($this->referrer_url); |
| 231 | if (!$url->is_valid_url() || $this->is_internal_referrer($this->referrer_url)) { |
| 232 | return $this->fetch_referrer(['domain' => '', 'type' => 'Direct', 'referrer' => 'Direct']); |
| 233 | } elseif (!\is_null(Known_Referrers::get_group_for($url->get_domain()))) { |
| 234 | $group = Known_Referrers::get_group_for($url->get_domain()); |
| 235 | return $this->fetch_referrer(['domain' => $group['domain'], 'type' => $group['type'], 'referrer' => $group['name']]); |
| 236 | } else { |
| 237 | return $this->fetch_referrer(['domain' => $url->get_domain(), 'type' => 'Referrer', 'referrer' => $this->strip_www($url->get_domain())]); |
| 238 | } |
| 239 | } |
| 240 | private function strip_www(string $string) : string |
| 241 | { |
| 242 | if (\strpos($string, "www.") !== 0) { |
| 243 | return $string; |
| 244 | } |
| 245 | return \substr($string, 4); |
| 246 | } |
| 247 | private function get_campaign() : ?int |
| 248 | { |
| 249 | global $wpdb; |
| 250 | $required_fields = ['utm_source', 'utm_medium', 'utm_campaign']; |
| 251 | $valid = \true; |
| 252 | foreach ($required_fields as $field) { |
| 253 | if (!isset($this->campaign_fields[$field])) { |
| 254 | $valid = \false; |
| 255 | } |
| 256 | } |
| 257 | if (!$valid) { |
| 258 | return null; |
| 259 | } |
| 260 | $campaigns_table = Query::get_table_name(Query::CAMPAIGNS); |
| 261 | $campaign = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$campaigns_table} WHERE landing_page_title = %s AND utm_source = %s AND utm_medium = %s AND utm_campaign = %s AND (utm_term = %s OR (%d = 0 AND utm_term IS NULL)) AND (utm_content = %s OR (%d = 0 AND utm_content IS NULL))", $this->resource->title(), $this->campaign_fields['utm_source'], $this->campaign_fields['utm_medium'], $this->campaign_fields['utm_campaign'], $this->campaign_fields['utm_term'], isset($this->campaign_fields['utm_term']) ? 1 : 0, $this->campaign_fields['utm_content'], isset($this->campaign_fields['utm_content']) ? 1 : 0)); |
| 262 | if (!\is_null($campaign)) { |
| 263 | return $campaign->campaign_id; |
| 264 | } |
| 265 | $wpdb->insert($campaigns_table, ['landing_page_title' => $this->resource->title(), 'utm_source' => $this->campaign_fields['utm_source'], 'utm_medium' => $this->campaign_fields['utm_medium'], 'utm_campaign' => $this->campaign_fields['utm_campaign'], 'utm_term' => $this->campaign_fields['utm_term'], 'utm_content' => $this->campaign_fields['utm_content']]); |
| 266 | $campaign = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$campaigns_table} WHERE landing_page_title = %s AND utm_source = %s AND utm_medium = %s AND utm_campaign = %s AND (utm_term = %s OR (%d = 0 AND utm_term IS NULL)) AND (utm_content = %s OR (%d = 0 AND utm_content IS NULL))", $this->resource->title(), $this->campaign_fields['utm_source'], $this->campaign_fields['utm_medium'], $this->campaign_fields['utm_campaign'], $this->campaign_fields['utm_term'], isset($this->campaign_fields['utm_term']) ? 1 : 0, $this->campaign_fields['utm_content'], isset($this->campaign_fields['utm_content']) ? 1 : 0)); |
| 267 | if (!\is_null($campaign)) { |
| 268 | return $campaign->campaign_id; |
| 269 | } |
| 270 | return null; |
| 271 | } |
| 272 | } |
| 273 |