-
Notifications
You must be signed in to change notification settings - Fork 0
/
Statistics.h
620 lines (594 loc) · 16.5 KB
/
Statistics.h
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
/*
* Copyright (C) 10/01/2020 VX STATS <sales@vxstats.com>
*
* This document is property of VX STATS. It is strictly prohibited
* to modify, sell or publish it in any way. In case you have access
* to this document, you are obligated to ensure its nondisclosure.
* Noncompliances will be prosecuted.
*
* Diese Datei ist Eigentum der VX STATS. Jegliche Änderung, Verkauf
* oder andere Verbreitung und Veröffentlichung ist strikt untersagt.
* Falls Sie Zugang zu dieser Datei haben, sind Sie verpflichtet,
* alles in Ihrer Macht stehende für deren Geheimhaltung zu tun.
* Zuwiderhandlungen werden strafrechtlich verfolgt.
*/
/* modules */
@import Foundation;
/* local class */
@class Reachability;
/**
* @~english
* @brief Communication with the statistics server.
*
* @b General:
* @n The class communicates with the statistics server in order to transfer a
* page impression or an action/event.
*
* @b Security:
* @n There is a multi-level security concept:
* @n 1. Communication must be authenticated via htaccess.
* @n 2. Configuration should be carried out via HTTPS only, so that all data is
* encrypted and cannot be manipulated.
* @n 3. Communication should be carried out via POST only. Only specific tools
* make a manipulation of data possible.
* @n 4. On the server part, all values are checked for validity; invalid entries
* are excluded.
*
* @b Threads:
* @n The class is thread-safe and can be executed in MainThread or in a
* BackgroundThread of the application.
* The queries are processed asynchronously or synchronously.
*
* @b Offline entries:
* @n Statistic entries that have not been sent successfully are filed in a
* queue of local settings and sent as soon as an
* internet connection is established. Estimations assume that there is
* less than 5% not received statistic data.
*
* @b Data privacy:
* @n Unique data is processed but no position data and also no user data that
* can be allocated directly.
* No third party is involved in the processing of data. The system with default
* settings is configured for security and anonymity.
*
* @b Application:
* @n Besides an API for iPhone/iPad/iPod touch and Android, e.g. C#, C, C++,
* PHP, JavaScript, and Java is also supported. Further formats can be supported
* upon request.
*
* @b Example:
* @n 1. Define a path to the statistics server.
* @code
* [[Statistics instance] serverFilePath:@"https://sandbox.vxstats.com"];
* @endcode
* 2. Transfer page impression.
* @code
* [[Statistics instance] page:@"MyPage"];
* [[Statistics instance] page:NSStringFromClass([self class])];
* @endcode
* 3. Transfer action.
* @code
* [[Statistics instance] event:@"action" value:@"value"];
* @endcode
*
* @~german
* @brief Kommunikation mit dem Statistikserver.
*
* @b Allgemein:
* @n Diese Klasse kommuniziert zum Statistikserver um eine Seitenimpression
* oder eine Aktion/ein Event zu übertragen.
*
* @b Sicherheit:
* @n Es ist ein mehrstufiges Sicherheitskonzept vorhanden:
* @n 1. Kommunikation muss über htaccess authentifiziert werden.
* @n 2. Konfiguration sollte nur über HTTPS erfolgen, damit werden alle Daten
* verschlüsselt und können nicht manipuliert werden.
* @n 3. Kommunikation sollte ausschließlich über POST erfolgen. Nur spezielle Tools
* erlauben somit eine Manipulation von Daten.
* @n 4. Serverseitig werden alle Werte auf Gültigkeit überprüft, ungültige
* Einträge sind ausgeschlossen.
*
* @b Threads:
* @n Die Klasse ist threadsicher und kann sowohl im MainThread ausgeführt werden
* oder in einem BackgroundThread der Anwendung. Die Anfragen werden
* entsprechend asynchron oder synchron abgearbeitet.
*
* @b Offline-Einträge:
* @n Nicht erfolgreich versendete Statistikeinträge werden in einer Queue der
* lokalen Einstellungen abgelegt und versendet, sobald wieder eine
* Internetverbindung besteht. Schätzungen gehen von weniger als 5% nicht
* empfangener Statistikdaten aus.
*
* @b Datenschutz:
* @n Es werden zwar eindeutige Daten verarbeitet, aber keine Positionsdaten und
* auch keine Benutzerdaten, die direkt zugeordnet werden können. Dritte sind nicht an
* der Verarbeitung der Daten beteiligt. Das System in der
* Standardkonfiguration ist auf Sicherheit und Anonymität ausgelegt.
*
* @b Verwendung:
* @n Neben einer API für iPhone/iPad/iPod touch und Android wird auch z.B. C#,
* C, C++, PHP, JavaScript und Java unterstützt. Weitere Formate erstellen wir
* natürlich gerne auf Anfrage.
*
* @b Beispiel:
* @n 1. Angeben eines Pfads zum Statistikserver.
* @code
* [[Statistics instance] serverFilePath:@"https://sandbox.vxstats.com"];
* @endcode
* 2. Seitenimpression übermitteln.
* @code
* [[Statistics instance] page:@"MyPage"];
* [[Statistics instance] page:NSStringFromClass([self class])];
* @endcode
* 3. Aktion übermitteln.
* @code
* [[Statistics instance] event:@"action" value:@"value"];
* @endcode
*/
@interface Statistics : NSObject <NSURLSessionDelegate> {
@private
/**
* @~english
* @brief The current network state.
*
* @~german
* @brief Der aktuelle Netzwerkstatus.
*/
NSString *m_status;
/**
* @~english
* @brief Path to statistics server.
*
* @~german
* @brief Der Pfad zum Statistikserver.
*/
NSString *m_serverFilePath;
/**
* @~english
* @brief Username for authorization.
*
* @~german
* @brief Benutzername für die Autorisierung.
*/
NSString *m_username;
/**
* @~english
* @brief Password for authorization.
*
* @~german
* @brief Passwort für die Autorisierung.
*/
NSString *m_password;
/**
* @~english
* @brief The last used page is buffered in order to use the actions and
* search comfortably.
*
* @~german
* @brief Die zuletzt verwendete Seite wird zwischengespeichert, um die
* Aktionen und Suchen komfortabel zu verwenden.
*/
NSString *lastPageName;
/**
* @~english
* @brief The last message to the statistics service that has not been sent.
*
* @~german
* @brief Die letzte nicht versendete Nachricht an den Statistiserver.
*/
NSString *m_lastMessage;
/**
* @~english
* @brief Checking connection in order to determine the connection speed or to
* transfer pending data.
*
* @~german
* @brief Überprüfen der Verbindung, um die Verbindungsgeschwindigkeit zu
* ermitteln oder ausstehende Daten zu senden.
*/
Reachability *m_reachability;
}
/**
* @~english
* @brief The last used page is buffered in order to use actions and searches
* comfortably.
*
* @~german
* @brief Die zuletzt verwendete Seite wird zwischengespeichert, um die Aktionen
* und Suchen komfortabel zu verwenden.
*/
@property (nonatomic, copy, readonly) NSString *lastPageName;
/**
* @~english
* @brief Update on connectivity.
*
* @~german
* @brief Update des Systems für die Art der Verbindung.
*/
- (void)manualUpdate;
/**
* @~english
* @brief Defines the path and name to the statistics server.
* @param serverFilePath The file name to the statistics server.
*
* @b Example:
* @n for the HTTPS address sandbox.vxstats.com and the folder /.
*
* @~german
* @brief Definiert den Pfad und Namen zum Statistikserver.
* @param serverFilePath Der Dateiname zum Statistikserver.
*
* @b Beispiel:
* @n Für die HTTPS-Adresse sandbox.vxstats.com und das Verzeichnis /.
*
* @~
* @code
* [[Statistics instance] serverFilePath:@"https://sandbox.vxstats.com"];
* @endcode
*/
- (void)serverFilePath:(NSString *)serverFilePath;
/**
* @~english
* @brief Defines the username to the statistics server.
* @param username The username to the statistics server.
*
* @~german
* @brief Definiert den Benutzernamen zum Statistikserver.
* @param username Der Benutzername zum Statistikserver.
*
* @~
* @code
* [[Statistics instance] username:@"sandbox"];
* @endcode
*/
- (void)username:(NSString *)username;
/**
* @~english
* @brief Defines the password to the statistics server.
* @param password The password to the statistics server.
*
* @~german
* @brief Definiert das Passwort zum Statistikserver.
* @param password Das Passwoort zum Statistikserver.
*
* @~
* @code
* [[Statistics instance] password:@"sandbox"];
* @endcode
*/
- (void)password:(NSString *)password;
/**
* @~english
* @brief Request a page with the name pageName in order to transfer it to the
* statistics server.
* @param pageName The name of the requested page.
* @note Limited to 255 characters.
*
* @~german
* @brief Aufruf einer Seite mit dem Namen pageName um es an den Statistikserver
* zu übermitteln.
* @param pageName Der Name der aufgerufenen Seite.
* @note Auf 255 Zeichen begrenzt.
*/
- (void)page:(NSString *)pageName;
/**
* @~english
* @brief If you would like to request a page with dynamic content please use
* this function.
*
* @b Example:
* @n Page with ads.
*
* @~german
* @brief Wenn Sie eine Seite mit dynamischem Inhalt aufrufen möchten, verwenden
* Sie diese Funktion.
*
* @b Beispiel:
* @n Seite mit Werbung.
*
* @~
* @code
* [[Statistics instance] event:@"ads" withValue:campaign];
* [[Statistics instance] event:@"ads" withValue:@"Apple"];
* @endcode
*
* @see Statistics#ads:
*
* @code
* [[Statistics instance] ads:campaign];
* @endcode
*
* @~english
* @b Example:
* @n Move map to geo position.
*
* @~german
* @b Beispiel:
* @n Karte auf Geoposition verschieben.
*
* @~
* @code
* [[Statistics instance] event:@"move" withValue:latitude,longitude];
* [[Statistics instance] event:@"move" withValue:@"52.523405,13.411400"];
* @endcode
*
* @see Statistics#move:longitude:
*
* @code
* [[Statistics instance] move:latitude longitude:longitude];
* @endcode
*
* @~english
* @b Example:
* @n Open browser with URL.
*
* @~german
* @b Beispiel:
* @n Browser mit URL öffnen.
*
* @~
* @code
* [[Statistics instance] event:@"open" withValue:urlOrName];
* [[Statistics instance] event:@"open" withValue:@"https://www.vxstat.com"];
* @endcode
*
* @see Statistics#open:
*
* @code
* [[Statistics instance] open:urlOrName];
* @endcode
*
* @~english
* @b Example:
* @n Play video.
*
* @~german
* @b Beispiel:
* @n Video abspielen.
*
* @~
* @code
* [[Statistics instance] event:@"play" withValue:urlOrName];
* [[Statistics instance] event:@"play" withValue:@"https://www.vxstats.com/movie.m4v"];
* @endcode
*
* @see Statistics#play:
*
* @code
* [[Statistics instance] play:urlOrName];
* @endcode
*
* @~english
* @b Example:
* @n Search for 'asdf'.
*
* @~german
* @b Beispiel:
* @n Suchen nach 'asdf'.
* @~
*
* @code
* [[Statistics instance] event:@"search" withValue:text];
* [[Statistics instance] event:@"search" withValue:@"asdf"];
* @endcode
*
* @see Statistics#search:
*
* @code
* [[Statistics instance] search:text];
* @endcode
*
* @~english
* @b Example:
* @n Shake the device.
*
* @~german
* @b Beispiel:
* @n @n Das Gerät schütteln.
* @~
*
* @code
* [[Statistics instance] event:@"shake" withValue:nil];
* @endcode
*
* @see Statistics#shake
*
* @code
* [[Statistics instance] shake];
* @endcode
*
* @~english
* @b Example:
* @n Touch the button for navigation.
*
* @~german
* @b Beispiel:
* @n Button für Navitation drücken.
* @~
*
* @code
* [[Statistics instance] event:@"touch" withValue:action];
* [[Statistics instance] event:@"touch" withValue:@"Navigation"];
* @endcode
*
* @see Statistics#touch:
*
* @code
* [[Statistics instance] touch:action];
* @endcode
*
* @~
* @param eventName @~english The event. @~german Das Event.
* @~
* @param value @~english The value for the event. @~german Der Wert für das
* Event.
*/
- (void)event:(NSString *)eventName withValue:(NSString *)value;
/**
* @~english
* @brief To capture ads - correspondingly the shown ad.
* @param campaign The displayed ad.
* @note Limited to 255 characters.
*
* @~german
* @brief Für das Erfassen von Werbeeinblendungen - entsprechend die angezeigte
* Werbung.
* @param campaign Die angezeigte Werbung.
* @note Auf 255 Zeichen begrenzt.
*
* @~
* @see Statistics#event:withValue:
*
* @code
* [[Statistics instance] event:@"ads" withValue:campaign];
* @endcode
*/
- (void)ads:(NSString *)campaign;
/**
* @~english
* @brief To capture map shifts - correspondingly the new center.
* @param latitude Latitude of center.
* @param longitude Longitude of center.
*
* @~german
* @brief Für die Erfassung von Kartenverschiebungen - entsprechend das neue Zentrum.
* @param latitude Latitude des Zentrums.
* @param longitude Longitude des Zentrums.
*
* @~
* @see Statistics#event:withValue:
*
* @code
* [[Statistics instance] event:@"move" withValue:latitude,longitude];
* @endcode
*/
- (void)move:(float)latitude longitude:(float)longitude;
/**
* @~english
* @brief To capture open websites or documents including the information which
* page or document has been requested.
* @param urlOrName The displayed website/document.
* @note Limited to 255 characters.
*
* @~german
* @brief Für die Erfassung von geöffneten Webseiten oder Dokumenten mit der
* Information, welche Seite bzw. welches Dokument aufgerufen wurde.
* @param urlOrName Die angezeigte Webseite/das angezeigte Dokument.
* @note Auf 255 Zeichen begrenzt.
*
* @~
* @see Statistics#event:withValue:
*
* @code
* [[Statistics instance] event:@"open" withValue:urlOrName];
* @endcode
*/
- (void)open:(NSString *)urlOrName;
/**
* @~english
* @brief To capture played files including the information which file/action
* has been played.
* @param urlOrName The played file.
* @note Limited to 255 characters.
*
* @~german
* @brief Für die Erfassung von abgespielten Dateien mit der Information,
* welche Datei/Aktion abgespielt wurde.
* @param urlOrName Die abgespielte Datei.
* @note Auf 255 Zeichen begrenzt.
*
* @~
* @see Statistics#event:withValue:
*
* @code
* [[Statistics instance] event:@"play" withValue:urlOrName];
* @endcode
*/
- (void)play:(NSString *)urlOrName;
/**
* @~english
* @brief To capture searches including the information for what has been
* searched.
* @param text The searched text.
* @note Limited to 255 characters.
*
* @~german
* @brief Für die Erfassung von Suchen mit der Information, nach was gesucht wurde.
* @param text Der gesuchte Text.
* @note Auf 255 Zeichen begrenzt.
*
* @~
* @see Statistics#event:withValue:
*
* @code
* [[Statistics instance] event:@"search" withValue:text];
* @endcode
*/
- (void)search:(NSString *)text;
/**
* @~english
* @brief To capture when the device has been shaken.
*
* @~german
* @brief Für die Erfassung, wann das Gerät geschüttelt wurde.
*
* @~
* @see Statistics#event:withValue:
*
* @code
* [[Statistics instance] event:@"shake" withValue:nil];
* @endcode
*/
- (void)shake;
/**
* @~english
* @brief To capture typed/touched actions.
* @param action The name of the touched action.
* @note Limited to 255 characters.
*
* @~german
* @brief Für die Erfassung von getippten/gedrückten Aktionen.
* @param action Der Name der getippten/gedrückten Aktion.
* @note Auf 255 Zeichen begrenzt.
*
* @~
* @see Statistics#event:withValue:
*
* @code
* [[Statistics instance] event:@"touch" withValue:action];
* @endcode
*/
- (void)touch:(NSString *)action;
/**
* @~english
* @brief The instance for statistics.
* The statistics system is initialized and creates a database for offline
* statistics that is only sent if a connection to the statistics server
* could be established. Please provide necessary settings for the communication
* to the server, its path, and which explicit values are also supposed to be collected.
*
* The communication to the server needs a token in order to get the
* authorization to capture statistic values.
* The complete communication is transfered by http or https protocol via POST.
* @note Please use https with TLS 1.2 and HSTS or better and enabled ipv6
* support.
* @return The instance for statistics.
*
* @~german
* @brief Die Instanz für Statistiken.
* Das Statistisystem wird initalisiert und erstellt eine Datenbank für Offline
* Statistik, die nur versendet wird, wenn eine Verbindung zum Statistikserver
* hergestellt werden konnte. Bitte hinterlegen Sie nötige Einstellungen für die
* Kommunikation zum Server, dessen Pfad und welche expliziten Werte ebenfalls
* gesammelt werden sollen.
*
* Die Kommunikation zum Server verlangt einen Token, um die Erlaubnis zu
* erhalten, statistische Werte zu erfassen.
* Die gesamte Kommunikation wird über das http(s)-Protokoll via POST
* übermittelt.
* @note Bitte nur https mit TLS 1.2 und HSTS oder besser und ipv6-Unterstützung
* verwenden.
* @return Die Instanz für Statistiken.
*/
+ (Statistics *)instance;
@end