-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.txt
2066 lines (2066 loc) · 84.4 KB
/
index.txt
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
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
root index SignPuddle 3 API https://signpuddle.com/server
line > v3.0.0
line
line Welcome to the SignPuddle 3 API.
line The API is defined with two types of source, two types of documentation, and a live page of HTML and JavaScript.
line
line + Source: [ApiTxt format](../src/index.txt) and [JSON objects](../src/index.json)
line + Documents: [API Blueprint](../doc/index.md) and [Stand Alone HTML](../doc/index.htm)
line + Live Page: [API Interface](../api/index.html) and [JavaScript](../api/index.js)
line
line The API is divided into several sections.
line This main document includes all of the sections.
line Each section is available separately as well.
line
line ## HTTP Request Methods
line
line The SignPuddle 3 server accepts HTTP request methods of GET, POST, PUT, and DELETE.
line + GET - retrieve information without altering the server
line + POST - add information to the server with each request
line + PUT - update information on the server
line + DELETE - remove information on the server.
line ## HTTP Response Statuses
line
line The SignPuddle 3 server responds with status codes.
line
line ### Success Codes
line
line + 200 OK
line + 201 Created
line + 202 Accepted
line + 204 No Content
line
line ### Redirect Codes
line
line + 300 Multiple Choices
line + 304 No Modified
line + 307 Temporary Redirect
line + 308 Permanent Redirect
line
line ### Client Error Codes
line
line + 400 Bad Request
line + 403 Forbidden
line + 404 Not Found
line + 409 Conflict
line + 429 Too Many Requests
line
line ### Server Error Codes
line
line + 500 Internal Server Error
line + 501 Not Implemented
line + 503 Service Unavailable
line
line ## HTTP Headers
line
line Headers pass additional information about the request or response.
line
line ### Headers
line
line + Content-Type - the MIME type of the response
line + ETag - an entity tag used to validate cached values
line + Expires - date after which response is stale
line + Location - used for redirect or for newly created resource
line + If-None-Match - request header compared to ETag value, response status 304 if matching
line + If-Modified-Since - request header, causes response status 304 if unmodified
line + Last-Modified - response header, used with If-Modified-Since request header
line
group user SignPuddle 3 collections are organized by country and language codes
line + Source: [ApiTxt format](../src/user.txt) and [JSON objects](../src/user.json)
line + Documents: [API Blueprint](../doc/user.md) and [Stand Alone HTML](../doc/user.htm)
line + Live Page: [API Interface](../api/user.html) and [JavaScript](../api/user.js)
route /user/who Who uses SignWriting? List of countries with size and activity.
method GET Retrieve country list The available countries where signs are available.
request user-who
response 200 text/plain
body BR
body US
route /user/pass User pass A string for accounting and validation
method POST String for accounting and validation
code echo json_pretty(userPass());
request user pass
response 200 text/plain
body {"pass": "90c19ce2076db097c75b3406e966a6b6","ip": "192.168.254.2"}
method PUT Check pass against user
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code verifyPass($data['username'],$data['pass']);
code $app->response->setStatus(204);
code return;
request user pass verify
line + Attributes
line + username: anonymous (string) - name of the user
line + pass: af77... (string) - pass for session validation
body {"username":"anonymous","pass":"af77..."}
response 204
route /user/login User login Validation of user with validated password
method PUT Process log in to server
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code $results = userVerify($data['username'],$data['pass'],$data['validated']);
code echo json_pretty($results);
request verify user application/json
line + Attributes
line + username: anonymous (string) - name of the user
line + pass: af77... (string) - pass for session validation
line + validated: 2793f... (string) - validated pass mixed with password
body {"username":"anonymous","pass":"af77...","validated":"2793f..."}
response 200 application/json
line response text here
body {"user-profile":""}
route /user/{name} User profile User details
parameter name slevinski string The name of a user
method PUT Update user profile Updates the profile of the user
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $user = userVerified($pass);
code if ($user!=$name) haltForbidden($user . " not " . $name);
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code userProfileUpdate($name,$data);
code $app->response->setStatus(204);
code return;
request user-update
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
method POST Register new user Creates and returns a new user
request user-add
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 200 text/plain
body profile created and returned
route /user/{name}/password User password User password resource
parameter name slevinski string The name of a user
method POST Update user password Updates the password of the user
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $user = userVerified($pass,true);
code if (!$user) haltForbidden();
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code $old = isset($data['old'])?$data['old']:'';
code $new = isset($data['new'])?$data['new']:'';
code if ($old && $new){
code userPasswordUpdate($name,$old,$new);
code $app->response->setStatus(204);
code return;
code } else {
code haltBadRequest();
code }
request user-update-password plain/text
header Pass 5ffab638bde372b4fa63bb6f8484595d
body {"old":"149603e6c03516362a8da23f624db945","new":"22af645d1859cb5ca6da0c484f1f37ea"}
response 204
method PUT Reset user password Creates a temporary password for the user
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $user = userVerified($pass,true);
code if (!$user) haltForbidden();
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code $user = isset($data['user'])?$data['user']:'';
code if ($user){
code userPasswordReset($user);
code $app->response->setStatus(204);
code return;
code } else {
code haltBadRequest();
code }
request user-password-reset plain/text
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
route /user/email User email requests Requests for email of username or password reset
method GET List of user email requests User email requests for username or passwords
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightscheck("",$pass,SP_ADMIN);
code $users = userEmailRequests();
code echo json_pretty($users);
code return;
request user-email-request
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 200 text/plain
body [{"name":"slevinski","email":"slevinski@signwriting.org","temp":"username"}]
route /user/email/{email} Username lookup Forgot username email lookup
parameter email slevinski@signwriting.org string The email for a user
method PUT Lookup username Creates a request for email of username
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $user = userVerified($pass,true);
code if (!$user) haltForbidden();
code userNameLookup($email);
code $app->response->setStatus(204);
code return;
request user-name-lookup
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
group collection Resources related to collections in general
line + Source: [ApiTxt format](../src/collection.txt) and [JSON objects](../src/collection.json)
line + Documents: [API Blueprint](../doc/collection.md) and [Stand Alone HTML](../doc/collection.htm)
line + Live Page: [API Interface](../api/collection.html) and [JavaScript](../api/collection.js)
route /collection{?name} Collections available
parameter name sp3 string partial collection name
method GET Get available collections
code $collections = collectionListing($name);
code if (count($collections)){
code echo json_pretty($collections);
code } else {
code $app->response->setStatus(204);
code }
code return;
response 200 text/plain
body ["en-US-interface-sp3"]
route /collection/{name} Collection resource Specific collection
parameter name `en-US-interface-sp3` string The name of a collection
method DELETE delete collection
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code collectionDelete($name,$pass);
code collectionSecurityDelete($name,$pass);
code collectionManageDelete($name,$pass);
code $app->response->setStatus(204);
request the removal of a collection
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
route /collection/{name}/entry/{ik}/image/{num} Collection entry image resource Specific image for collection entry
parameter name `ase-US-dictionary-public` string The name of an dictionary
parameter ik 11244 string An id number or key string
parameter num 1 string The image number of 1 thru 4
method PUT update image for collection entry
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code collectionImageUpdate($name,$ik,$num,$data,$pass);
code $app->response->setStatus(204);
code return;
request an update for an existing dictionary entry application/json
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
body {
body "file": "name.png",
body "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD..."
body }
response 204
method DELETE remove dictionary entry
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code collectionImageDelete($name,$ik,$num,$pass);
code $app->response->setStatus(204);
request the removal of a collection entry image
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 204
route /collection/{name}/stats Collection statistics Statistics about the collection
parameter name `ase-US-dictionary-public` required,string The name of a dictionary
method GET Get collection statistics
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check){
code haltNotModified();
code }
code header('Last-Modified: ' . $lastModified);
code $output = json_pretty(collectionStats($name));
code $searchTime = searchtime($timein);
code header("Search-Time: " . $searchTime);
code echo $output;
request collections statistics
header If-Modified-Since 2019-01-16T16:56:19.175Z
response 200 text/plain
body [{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}]
route /collection/security Collections security Security settings for all collections
method GET Get collections security
code $headers = getHeaders();
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $lastModified = lastModifiedCollection();
code if ($lastModified <= $check){
code haltNotModified();
code }
code header('Last-Modified: ' . $lastModified);
code echo json_pretty(collectionsSecurity());
request collections security
header If-Modified-Since 2019-01-16T16:56:19.175Z
response 200 text/plain
body [{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}]
route /collection/{name}/security Collection security Details about the collection security
parameter name `en-US-interface-sp3` required,string The name of the collection
method GET retrieve collection security
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code echo json_pretty(collectionSecurity($name));
request interface security
response 200 text/plain
body {"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}
method PUT Update collection security
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code collectionSecurityUpdate($name,$data,$pass);
code $app->response->setStatus(204);
code return;
request an update for an existing entry text/plain
header Pass 5ffab638bde372b4fa63bb6f8484595d
body {"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}
response 204
method DELETE Remove security for collection
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code collectionSecurityDelete($name,$pass);
code $app->response->setStatus(204);
request the deletion of collection security
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
route /collection/{name}/users Collection users
parameter name `ase-US-dictionary-public` string collection name
method GET Get collection users
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code echo json_pretty(collectionUsers($name));
response 200 text/plain
body [{"user": "test_user","security": 3}]
route /collection/manage/unknown Management for unknown collections
method GET Get list of unknown collections with user management
code echo json_pretty(collectionManageUnknown());
response 200 text/plain
body ["es-US-interface-sp3"]
route /collection/{name}/manage Collection users management
parameter name `ase-US-dictionary-public` string collection name
method GET Get collection management
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code echo json_pretty(collectionUsersDetail($name,$pass));
request collection management
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 200 text/plain
body [{"name": "test_user","display": "Test Editor","email": "testing@gmail.com","security": 3}]
method PUT Update collection management
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code collectionManageUpdate($name,$data,$pass);
code $app->response->setStatus(204);
code return;
request an update for collection management
header Pass 5ffab638bde372b4fa63bb6f8484595d
body {"user":"slevinski","security":4}
response 204
method DELETE Remove user management for collection
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code collectionManageDelete($name,$pass);
code $app->response->setStatus(204);
request the removal of user management for a collection
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
route /collection/{name}/manage/{user} Collection user
parameter name `ase-US-dictionary-public` string collection name
parameter user `slevinski` string user name
method DELETE Remove user from collection management
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code collectionManageRemove($name,$user,$pass);
code $app->response->setStatus(204);
request the removal of a user from collection management
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
route /collection/{name}/request/{source} Collection Request Copy
parameter name `es-US-interface-sp3` required,string The name of the new collection
parameter source `en-US-interface-sp3` required,string The name of the source collection
method POST request the creation of a new collection
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $user = userVerified($pass);
code if (!$user) haltForbidden();
code rightsCheck($source,$pass,SP_VIEW);
code $err = invalidName($source);
code if ($err){
code haltBadRequest($err);
code }
code $parts = explode("-",$source);
code $err = invalidName($name,$parts[2]);
code if ($err){
code haltBadRequest($err);
code }
code $dir = 'data/db/';
code $infile = $dir . $source . ".db";
code $outfile = $dir . $name . ".db";
code if (!file_exists($infile)) haltBadRequest('Source collection does not exist: ' . $source);
code if (file_exists($outfile)) haltBadRequest('Collection already exists: ' . $name);
code if (copy($infile,$outfile)){
code $data = array();
code $data["user"] = $user;
code $data["security"] = SP_EDIT;
code collectionManageUpdate($name,$data,$pass,true);
code
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code $title = isset($data['title'])?$data['title']:'New Collection';
code $data = array();
code $data["title"] = $title;
code $data["user"] = "admin";
code $data["view_pass"] = 0;
code $data["add_pass"] = 1;
code $data["edit_pass"] = 1;
code $data["register_level"] = 0;
code $data["upload_level"] = 4;
code collectionSecurityUpdate($name,$data,$pass,true);
code $app->response->setStatus(204);
code return;
code } else {
code haltForbidden();
code }
request new collection from source
header Pass 5ffab638bde372b4fa63bb6f8484595d
response 204
group interface Resources related to interface collections
line + Source: [ApiTxt format](../src/interface.txt) and [JSON objects](../src/interface.json)
line + Documents: [API Blueprint](../doc/interface.md) and [Stand Alone HTML](../doc/interface.htm)
line + Live Page: [API Interface](../api/interface.html) and [JavaScript](../api/interface.js)
route /interface{?name} Interfaces available
parameter name sp3 string partial interface name
method GET Get available interfaces
code $dir = 'data/db/';
code $ext = '.db';
code $out = [];
code if ($name){
code if (strpos($name,"interface")!==false){
code $interfaces = $dir . '*' . $name . '*' . $ext;
code $files = glob($interfaces);
code } else {
code $interfaces = $dir . '*interface*' . $name . '*' . $ext;
code $files = glob($interfaces);
code if (count($files)==0) {
code $interfaces = $dir . '*' . $name . '*interface*' . $ext;
code $files = glob($interfaces);
code }
code }
code } else {
code $interfaces = $dir . '*interface*' . $ext;
code $files = glob($interfaces);
code }
code foreach ($files as $filename) {
code $out[] = str_replace($ext,'',str_replace($dir,'',$filename));
code }
code if (count($out)){
code echo json_pretty($out);
code } else {
code $app->response->setStatus(204);
code }
code return;
response 200 text/plain
body ["en-US-interface-sp3"]
route /interface/{name}{?update} Interface resource Access to available interfaces
parameter name `en-US-interface-sp3` required,string The name of an interface
parameter update 1 optional,number Forces a rewrite of the interface for json and txt formats
method GET retrieve interface
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code if (strpos($name,'.')){
code $parts = explode('.',$name);
code $name = $parts[0];
code $format = $parts[1];
code if (!in_array($format,['db','txt','json'])){
code haltNotFound();
code }
code } else {
code $format = 'json';
code }
code $dir = 'data/' . $format . '/';
code $ext = '.' . $format;
code $file = $dir . $name . $ext;
code $err = invalidName($name);
code if ($err){
code $files = glob('data/db/' . $name . '*interface-sp3.db');
code if (count($files)==0){
code haltBadRequest($err);
code } else {
code $name = str_replace(".db",'',str_replace('data/db/','',$files[0]));
code }
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check && !$update){
code haltNotModified();
code }
code if ($format=='json' && (!file_exists($file) || $update)) {
code $json = interface2json($name);
code file_put_contents($file,$json);
code } else if ($format=='txt' && (!file_exists($file) || $update)) {
code $txt = interface2txt($name);
code file_put_contents($file,$txt);
code }
code if(file_exists($file)) {
code header('Last-Modified: ' . $lastModified);
code $searchTime = searchtime($timein);
code header("Search-Time: " . $searchTime);
code getFile($file);
code } else {
code haltNotFound();
code }
request interface text
header If-Modified-Since 2019-01-16T16:56:19.175Z
response 200 text/plain
body print.buttons.main<TAB>message<TAB>description<TAB>icon
route /interface/{name}/key Interface keys Access to interface keys
parameter name `en-US-interface-sp3` required,string The name of an interface
method GET retrieve interface keys
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check){
code haltNotModified();
code }
code header('Last-Modified: ' . $lastModified);
code echo json_pretty(interfaceKeys($name,$pass));
request interface keys
header If-Modified-Since 2019-01-16T16:56:19.175Z
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 200 text/plain
body ["print.buttons.main"]
route /interface/{name}/search/{text} Interface entries search Search interface for text
parameter name `en-US-interface-sp3` required,string The name of an interface
parameter text `SignPuddle` required,string The text for searching
method GET retrieve matching entries
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code echo json_pretty(interfaceSearch($name,$text,$pass));
request matching interface entries
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 200 text/plain
body [
body {
body "key": "print.buttons.main",
body "message": "Print it!"
body }
body ]
route /interface/{name}/entry Interface entry resource Entries for interface
parameter name `en-US-interface-sp3` string The name of an interface
method POST add interface entry
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code if (!$pass){
code haltForbidden();
code }
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code interfaceEntryNew($name,$data,$pass);
code $app->response->setStatus(201);
code return;
request add new interface entry application/json
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
body {"key":"new.key.one", "message":"UI text","description":"about the text","icon":"search"}
response 201 text/plain
body ...
route /interface/{name}/entry/{key} Interface entry resource for key Specific entries for interface
parameter name `en-US-interface-sp3` string The name of an interface
parameter key system.button.open string The name of an interface key
method GET retrieve interface entry
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $entries = interfaceKeySearch($name,$key,$pass);
code if (!$entries){
code haltNoContent();
code }
code $lastModified = max(array_map(function($o) {return $o->updated_at;},$entries));
code if ($lastModified <= $check){
code haltNotModified();
code }
code header('Last-Modified: ' . $lastModified);
code echo json_pretty($entries);
request an interface entry
header If-Modified-Since 2019-01-16T16:56:19.175Z
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 200 text/plain
body ...
method PUT update interface entry
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code interfaceEntryUpdate($name,$key,$data,$pass);
code $app->response->setStatus(204);
code return;
request an update for an existing entry
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
body {"key":"new.key.one", "message":"UI text","description":"about the text","icon":"search"}
response 204
method DELETE remove interface entry
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code interfaceEntryDelete($name,$key,$pass);
code $app->response->setStatus(204);
request the removal of an interface entry
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 204
group dictionary Resources related to dictionary collections
line + Source: [ApiTxt format](../src/dictionary.txt) and [JSON objects](../src/dictionary.json)
line + Documents: [API Blueprint](../doc/dictionary.md) and [Stand Alone HTML](../doc/dictionary.htm)
line + Live Page: [API Dictionary](../api/dictionary.html) and [JavaScript](../api/dictionary.js)
route /dictionary{?name} Dictionaries available
parameter name public string partial dictionary name
method GET Get available dictionaries
code $dir = 'data/db/';
code $ext = '.db';
code $out = [];
code if ($name){
code if (strpos($name,"dictionary")!==false){
code $dictionaries = $dir . '*' . $name . '*' . $ext;
code $files = glob($dictionaries);
code } else {
code $dictionaries = $dir . '*dictionary*' . $name . '*' . $ext;
code $files = glob($dictionaries);
code if (count($files)==0) {
code $dictionaries = $dir . '*' . $name . '*dictionary*' . $ext;
code $files = glob($dictionaries);
code }
code }
code } else {
code $dictionaries = $dir . '*dictionary*' . $ext;
code $files = glob($dictionaries);
code }
code foreach ($files as $filename) {
code $out[] = str_replace($ext,'',str_replace($dir,'',$filename));
code }
code if (count($out)){
code echo json_pretty($out);
code } else {
code $app->response->setStatus(204);
code }
code return;
response 200 text/plain
body ["ase-US-dictionary-public"]
route /dictionary/{name}{?update} Dictionary resource Access to available dictionaries
parameter name `ase-US-dictionary-public` required,string The name of an dictionary
parameter update 1 optional,number Forces a rewrite of the dictionary for json and txt formats
method GET retrieve dictionary
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code if (strpos($name,'.')){
code $parts = explode('.',$name);
code $name = $parts[0];
code $format = $parts[1];
code if (!in_array($format,['db','txt','json'])){
code haltNotFound();
code }
code } else {
code $format = 'json';
code }
code $dir = 'data/' . $format . '/';
code $ext = '.' . $format;
code $file = $dir . $name . $ext;
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check && !$update){
code haltNotModified();
code }
code if ($format=='json' && (!file_exists($file) || $update)) {
code $json = dictionary2json($name);
code file_put_contents($file,$json);
code } else if ($format=='txt' && (!file_exists($file) || $update)) {
code $txt = dictionary2txt($name);
code file_put_contents($file,$txt);
code }
code if(file_exists($file)) {
code header('Last-Modified: ' . $lastModified);
code $searchTime = searchtime($timein);
code header("Search-Time: " . $searchTime);
code getFile($file);
code } else {
code haltNotFound();
code }
request dictionary text
header If-Modified-Since 2019-01-16T16:56:19.175Z
response 200 text/plain
body 1<TAB>𝠀𝠃𝤝𝤔𝣰𝣹𝤎𝤁𝣽𝤀<TAB>test zero<TAB>test zero<TAB>we are testing SignPuddle 1.6<TAB>Val ;-)<TAB>{"video":"<iframe width=\"425\" height=\"349\" src=\"http:\/\/www.youtube.com\/embed\/RTniYA1lTDM\" frameborder=\"0\" allowfullscreen><\/iframe>"}<TAB>Val<TAB>2011-07-20T17:39:02Z<TAB>2011-07-20T17:42:09Z
route /dictionary/{name}/signs List of dictionary signs The signs in the dictionary
parameter name `ase-US-dictionary-public` string The name of an dictionary
method GET retrieve dictionary signs
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check){
code haltNotModified();
code }
code header('Last-Modified: ' . $lastModified);
code $output = dictionarySigns($name);
code $searchTime = searchtime($timein);
code header("Search-Time: " . $searchTime);
code echo $output;
request dictionary text
header If-Modified-Since 2019-01-16T16:56:19.175Z
response 200 text/plain
body 𝠀𝠃𝤝𝤔𝣰𝣹𝤎𝤁𝣽𝤀
route /dictionary/{name}/signtexts List of dictionary signtexts The signtexts in the dictionary
parameter name `ase-US-dictionary-public` string The name of an dictionary
method GET retrieve dictionary signtexts
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check){
code haltNotModified();
code }
code header('Last-Modified: ' . $lastModified);
code $output = dictionarySigntexts($name);
code $searchTime = searchtime($timein);
code header("Search-Time: " . $searchTime);
code echo $output;
request dictionary text
header If-Modified-Since 2019-01-16T16:56:19.175Z
response 200 text/plain
body 𝠀𝠃𝤝𝤔𝣰𝣹𝤎𝤁𝣽𝤀
route /dictionary/{name}/entry Dictionary entry resource Entries for dictionary
parameter name `ase-US-dictionary-public` string The name of an dictionary
method POST add dictionary entry
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code echo dictionaryEntryNew($name,$data,$pass);
code $app->response->setStatus(201);
code return;
request add new dictionary entry application/json
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
body {
body "sign": "\ud836\udc03\ud836\udd44\ud836\udd19\ud8ef\udfa1\ud836\udcf4\ud836\udcf4\ud8dd\udc54\ud836\udcc8\ud836\udcfc\ud8dd\udc42\ud836\udd26\ud836\udcfa\ud8c8\uddd2\ud836\udd15\ud836\udcee\ud8c8\uddda\ud836\udce0\ud836\udcef",
body "terms": [
body "Malaysia"
body ],
body "signtext": "",
body "text": "",
body "source": "Conference Maastricht",
body "detail": {}
body }
response 201 text/plain
body 777
route /dictionary/{name}/entry/{id} Dictionary entry resource for id Specific entries for dictionary
parameter name `ase-US-dictionary-public` string The name of an dictionary
parameter id 11244 string An id numbers
method PUT update dictionary entry
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code $data = $app->request->getbody();
code $data = json_decode($data,true);
code dictionaryEntryUpdate($name,$id,$data,$pass);
code $app->response->setStatus(204);
code return;
request an update for an existing dictionary entry application/json
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
body {
body "sign": "\ud836\udc03\ud836\udd44\ud836\udd19\ud8ef\udfa1\ud836\udcf4\ud836\udcf4\ud8dd\udc54\ud836\udcc8\ud836\udcfc\ud8dd\udc42\ud836\udd26\ud836\udcfa\ud8c8\uddd2\ud836\udd15\ud836\udcee\ud8c8\uddda\ud836\udce0\ud836\udcef",
body "terms": [
body "Malaysia"
body ],
body "signtext": "",
body "text": "",
body "source": "Conference Maastricht",
body "detail": {}
body }
response 204
method DELETE remove dictionary entry
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code dictionaryEntryDelete($name,$id,$pass);
code $app->response->setStatus(204);
request the removal of an dictionary entry
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 204
route /dictionary/{name}/search{?offset,limit,filter,sort,results} Search dictionary Searching dictionary signs
parameter name `ase-US-dictionary-public` required,string The name of a dictionary
parameter offset 0 number Start of search results
parameter limit 10 number Number of search results
parameter filter user=Val string restrict search results
parameter sort created_at string Field for sorting results
parameter results sign string Type of results: entries, sign, term, terms
method GET retrieve dictionary results of searching
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check){
code haltNotModified();
code }
code $output = json_pretty(dictionarySearch($name,$offset,$limit,$filter,$sort,$results));
code header('Last-Modified: ' . $lastModified);
code $searchTime = searchtime($timein);
code header("Search-Time: " . $searchTime);
code echo $output;
request dictionary query results
header If-Modified-Since 2019-01-16T16:56:19.175Z
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 200 text/plain
body {
body "total": 1,
body "data": [
body [
body "1",
body "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
body ]
body ]
body }
route /dictionary/{name}/search/id/{id}{?offset,limit,filter,sort,results} Search dictionary with ids Specific entries for dictionary
parameter name `ase-US-dictionary-public` string The name of an dictionary
parameter id 1-4,5 string A list of one or more id numbers
parameter offset 0 number Start of search results
parameter limit 10 number Number of search results
parameter filter user=Val string restrict search results
parameter sort created_at string Field for sorting results
parameter results sign string Type of results: entries, sign, term, terms
method GET retrieve dictionary entry
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check){
code haltNotModified();
code }
code $output = json_pretty(dictionarySearchId($name,$id,$offset,$limit,$filter,$sort,$results));
code header('Last-Modified: ' . $lastModified);
code echo $output;
request an dictionary entry
header If-Modified-Since 2019-01-16T16:56:19.175Z
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 200 text/plain
body [
body {
body "id": "1",
body "sign": "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00",
body "terms": [
body "test zero"
body ],
body "lower": [
body "test zero"
body ],
body "signtext": "",
body "text": "we are testing SignPuddle 1.6",
body "source": "Val ;-)",
body "detail": {
body "video": "<iframe width=\"425\" height=\"349\" src=\"http:\/\/www.youtube.com\/embed\/RTniYA1lTDM\" frameborder=\"0\" allowfullscreen><\/iframe>"
body },
body "user": "Val",
body "created_at": "2011-07-20T17:39:02Z",
body "updated_at": "2011-07-20T17:42:09Z"
body }
body ]
route /dictionary/{name}/search/sign/{query}{?offset,limit,filter,sort,results} Search signs with query string Query string access to dictionary signs
parameter name `ase-US-dictionary-public` required,string The name of a dictionary
parameter query Q required,string A query string
parameter offset 0 number Start of search results
parameter limit 10 number Number of search results
parameter filter user=Val string restrict search results
parameter sort created_at string Field for sorting results
parameter results sign string Type of results: entries, sign, term, terms
method GET retrieve dictionary results of searching signs with query string
code $headers = getHeaders();
code $pass = isset($headers['Pass'])?$headers['Pass']:'';
code rightsCheck($name,$pass,SP_VIEW);
code $check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
code $err = invalidName($name);
code if ($err){
code haltBadRequest($err);
code }
code $lastModified = lastModified($name);
code if ($lastModified <= $check){
code haltNotModified();
code }
code header('Last-Modified: ' . $lastModified);
code $output = json_pretty(dictionarySearchSign($name,$query,$offset,$limit,$filter,$sort,$results));
code $searchTime = searchtime($timein);
code header("Search-Time: " . $searchTime);
code echo $output;
request dictionary query results
header If-Modified-Since 2019-01-16T16:56:19.175Z
header Pass 724fd4b4438fba9d0c5ab89d0833e5c9
response 200 text/plain
body {
body "total": 1,
body "data": [
body [
body "1",
body "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
body ]
body ]
body }
route /dictionary/{name}/search/signtext/{query}{?offset,limit,filter,sort,results} Search signtexts with query string Query string access to dictionary signtexts
parameter name `ase-US-dictionary-public` required,string The name of a dictionary
parameter query Q required,string A query string
parameter offset 0 number Start of search results
parameter limit 10 number Number of search results
parameter filter user=Val string restrict search results