forked from stefanofranco/yourls-api-shorturl-analytics
-
Notifications
You must be signed in to change notification settings - Fork 0
/
plugin.php
148 lines (126 loc) · 4.13 KB
/
plugin.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php
/*
Plugin Name: API ShortURL Analytics
Plugin URI: https://github.com/stefanofranco/yourls-api-shorturl-analytics
Description: This plugin defines a custom API action 'shorturl_analytics'
Version: 1.0.0
Author: Stefano Franco
Author URI: https://github.com/stefanofranco/
*/
yourls_add_filter('api_action_shorturl_analytics', 'shorturl_analytics');
/**
* @return array
* @throws Exception
*/
function shorturl_analytics(): array
{
// The date parameter must exist
if( !isset( $_REQUEST['date'] ) ) {
return [
'statusCode' => 400,
'message' => 'Missing date parameter',
];
}
$date_start = $_REQUEST['date'];
$date_end = $_REQUEST['date_end'] ?? $date_start;
// Check if the date format is right
if (
!checkDateFormat($date_start) ||
!checkDateFormat($date_end)
) {
return [
'statusCode' => 400,
'message' => 'Wrong date format',
];
}
// Check if "date_end" is not smaller than "date_start"
if( $date_end < $date_start ) {
return [
'statusCode' => 400,
'message' => 'The date_end parameter cannot be smaller than date',
];
}
// Need 'shorturl' parameter
if( !isset( $_REQUEST['shorturl'] ) ) {
return [
'statusCode' => 400,
'message' => 'Missing shorturl parameter',
];
}
$shorturl = $_REQUEST['shorturl'];
// Check if valid shorturl
if( !yourls_is_shorturl( $shorturl ) ) {
return [
'statusCode' => 404,
'message' => 'Not found',
];
}
$stats = extractStats($shorturl, $date_start, $date_end);
return [
'statusCode' => 200,
'message' => 'success',
'stats' => $stats
];
}
/**
* @throws Exception
*/
function extractStats($shorturl, $date_start, $date_end = null)
{
global $ydb;
if (!empty($date_start)) {
$date_end = ($date_end ?? $date_start);
$datesRange = getDateRange($date_start, ($date_end ?? $date_start));
// Date must be in YYYY-MM-DD format
$date_start .= ' 00:00:00';
$date_end .= ' 23:59:59';
try {
// Count total numbers of click
$total_clicks = $ydb->fetchOne("SELECT COUNT(*) as count FROM " . YOURLS_DB_TABLE_LOG . " WHERE `shorturl` = :shorturl", ['shorturl' => $shorturl]);
// Count total numbers of click for any date in the range
$daily_clicks = $ydb->fetchPairs("SELECT DATE(`click_time`) as date, COUNT(*) as count FROM " . YOURLS_DB_TABLE_LOG . " WHERE `shorturl` = :shorturl AND `click_time` BETWEEN :date_start AND :date_end GROUP BY `date`", ['shorturl' => $shorturl, 'date_start' => $date_start, 'date_end' => $date_end]);
} catch (\Throwable $e) {
var_dump($e->getMessage()); die;
}
$results = [
'total_clicks' => (int) $total_clicks[array_key_first($total_clicks)],
'range_clicks' => 0,
'daily_clicks' => [],
];
foreach ($datesRange as $date) {
$results['daily_clicks'][$date] = (int) ($daily_clicks[$date] ?? 0);
$results['range_clicks'] += $results['daily_clicks'][$date];
}
return $results;
}
return [];
}
/**
* Check if a date is in the format 'Y-m-d'.
*
* @param string $date The date to check for.
* @param string $format
* @return bool True if $date format is equal to the one specified by $format
* (default: 'Y-m-d'). Otherwise, the function returns False.
*/
function checkDateFormat($date, $format='Y-m-d'): bool
{
$dateObject = DateTime::createFromFormat($format, $date);
return $dateObject && $dateObject->format($format) === $date;
}
/**
* @throws Exception
*/
function getDateRange($startDate, $endDate): array
{
$start = new DateTime($startDate);
$end = new DateTime($endDate);
$end = $end->modify('+1 day');
$interval = new DateInterval('P1D');
$dateRange = new DatePeriod($start, $interval ,$end);
$results = [];
foreach ($dateRange as $date) {
$results[] = $date->format('Y-m-d');
}
return $results;
}