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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
|
/****************************************************************************************************
RepRapFirmware - Webserver
This class serves a single-page web applications to the attached network. This page forms the user's
interface with the RepRap machine. This software interprests returned values from the page and uses it
to generate G Codes, which it sends to the RepRap. It also collects values from the RepRap like
temperature and uses those to construct the web page.
The page itself - reprap.htm - uses Jquery.js to perform AJAX. See:
http://jquery.com/
-----------------------------------------------------------------------------------------------------
Version 0.2
10 May 2013
Adrian Bowyer
RepRap Professional Ltd
http://reprappro.com
Licence: GPL
-----------------------------------------------------------------------------------------------------
The supported requests are GET requests for files (for which the root is the www directory on the
SD card), and the following. These all start with "/rr_". Ordinary files used for the web interface
must not have names starting "/rr_" or they will not be found. Times should be generally specified
in the format YYYY-MM-DDTHH:MM:SS so the firmware can parse them.
rr_connect?password=xxx&time=yyy
Sent by the web interface software to establish an initial connection, indicating that
any state variables relating to the web interface (e.g. file upload in progress) should
be reset. This only happens if the password could be verified.
rr_fileinfo Returns file information about the file being printed.
rr_fileinfo?name=xxx
Returns file information about a file on the SD card or a JSON-encapsulated response
with err = 1 if the passed filename was invalid.
rr_status New-style status response, in which temperatures, axis positions and extruder positions
are returned in separate variables. Another difference is that extruder positions are
returned as absolute positions instead of relative to the previous gcode. A client
may also request different status responses by specifying the "type" keyword, followed
by a custom status response type. Also see "M105 S1".
rr_filelist?dir=xxx
Returns a JSON-formatted list of all the files in xxx including the type and size in the
following format: "files":[{"type":'f/d',"name":"xxx",size:yyy},...]
rr_files?dir=xxx&flagDirs={1/0} [DEPRECATED]
Returns a listing of the filenames in the /gcode directory of the SD card. 'dir' is a
directory path relative to the root of the SD card. If the 'dir' variable is not present,
it defaults to the /gcode directory. If flagDirs is set to 1, all directories will be
prefixed by an asterisk.
rr_reply Returns the last-known G-code reply as plain text (not encapsulated as JSON).
rr_configfile [DEPRECATED]
Sends the config file as plain text (not encapsulated as JSON either).
rr_download?name=xxx
Download a specified file from the SD card
rr_upload?name=xxx&time=yyy
Upload a specified file using a POST request. The payload of this request has to be
the file content. Only one file may be uploaded at once. When the upload has finished,
a JSON response with the variable "err" will be returned, which will be 0 if the job
has finished without problems, it will be set to 1 otherwise.
rr_delete?name=xxx
Delete file xxx. Returns err (zero if successful).
rr_mkdir?dir=xxx
Create a new directory xxx. Return err (zero if successful).
rr_move?old=xxx&new=yyy
Rename an old file xxx to yyy. May also be used to move a file to another directory.
****************************************************************************************************/
#include "RepRapFirmware.h"
const char* overflowResponse = "overflow";
const char* badEscapeResponse = "bad escape";
// Constructor and initialisation
Webserver::Webserver(Platform* p, Network *n) : state(doingFilename), platform(p), network(n), numSessions(0), clientsServed(0)
{
gcodeReadIndex = gcodeWriteIndex = 0;
gcodeReply = new OutputStack();
processingDeferredRequest = false;
seq = 0;
webserverActive = false;
}
void Webserver::Init()
{
// initialise the webserver class
longWait = platform->Time();
webserverActive = true;
numSessions = clientsServed = 0;
uploadIp = 0;
// initialise all protocol handlers
ResetState();
}
// Deal with input/output from/to the client (if any)
void Webserver::Spin()
{
if (webserverActive)
{
uint32_t ip;
size_t length;
uint32_t fragment;
const char* request = network->GetRequest(ip, length, fragment);
if (request != nullptr)
{
if (reprap.Debug(moduleWebserver))
{
platform->MessageF(HOST_MESSAGE, "Request: %s fragment %u\n", request, fragment);
}
uint32_t fragNum = fragment & ~lastFragmentFlag;
if (fragNum == 0)
{
HttpSession *session = StartSession(ip);
if (session == nullptr)
{
network->SendReply(ip, 400, "Too many sessions");
}
else
{
// First fragment, so parse the request
ResetState();
const char *error = nullptr;
bool finished = false;
while (!finished && length != 0)
{
finished = CharFromClient(*request++, error);
--length;
}
if (!finished)
{
error = "Incomplete command";
}
if (error != nullptr)
{
network->SendReply(ip, 400, error);
}
else
{
ProcessFirstFragment(*session, clientMessage, (fragment & lastFragmentFlag) != 0);
}
}
}
else
{
HttpSession *session = FindSession(ip);
if (session != nullptr)
{
ProcessUploadFragment(*session, request, length, fragment);
}
else
{
// Discard the message
network->DiscardMessage();
platform->MessageF(DEBUG_MESSAGE, "session not found, fragment=%u\n", fragment);
}
}
}
}
CheckSessions();
platform->ClassReport(longWait);
}
// This is called to process a file upload request.
void Webserver::StartUpload(HttpSession& session, const char* fileName, uint32_t fileLength, time_t lastModified)
{
CancelUpload(session);
if (uploadIp != 0)
{
session.uploadState = uploadBusy; // upload buffer already in use
}
else
{
FileStore *file = platform->GetFileStore(FS_PREFIX, fileName, true);
if (file == nullptr)
{
session.uploadState = cantCreate;
}
else
{
session.fileBeingUploaded.Set(file);
strncpy(session.filenameBeingUploaded, fileName, FILENAME_LENGTH);
session.fileLastModified = lastModified;
session.postLength = fileLength;
session.bytesWritten = 0;
session.nextFragment = 1;
session.uploadState = uploading;
session.bufNumber = 0;
session.bufPointer = 0;
uploadIp = session.ip;
}
}
}
// This is called when we have received the last upload packet
void Webserver::FinishUpload(HttpSession& session)
{
bool b = session.fileBeingUploaded.Close();
if (session.uploadState == uploading)
{
if (!b)
{
session.uploadState = cantClose;
}
else if (session.bytesWritten != session.postLength)
{
session.uploadState = wrongLength;
}
else if (session.fileLastModified != 0)
{
// Upload OK, update the file timestamp if it was specified before
(void)platform->GetMassStorage()->SetLastModifiedTime(session.filenameBeingUploaded, session.fileLastModified);
}
}
if (session.uploadState != uploading)
{
platform->MessageF(HOST_MESSAGE, "Error: Upload finished in state %d\n", (int)session.uploadState);
}
network->SendReply(session.ip, 200 | rcJson, (session.uploadState == uploading) ? "{\"err\":0}" : "{\"err\":1}");
session.uploadState = notUploading;
}
void Webserver::CancelUpload(HttpSession& session)
{
if (session.fileBeingUploaded.IsLive())
{
session.fileBeingUploaded.Close();
//TODO delete the file as well
}
if (uploadIp == session.ip)
{
uploadIp = 0;
}
}
void Webserver::ProcessUploadFragment(HttpSession& session, const char* request, size_t length, uint32_t fragment)
{
if (session.uploadState == uploading)
{
//platform->MessageF(HOST_MESSAGE, "writing fragment=%u\n", fragment);
uint32_t frag = fragment & ~lastFragmentFlag;
if (frag != session.nextFragment)
{
platform->MessageF(HOST_MESSAGE, "expecting fragment %u received %u\n", session.nextFragment, frag);
session.uploadState = wrongFragment;
}
}
if (session.uploadState == uploading)
{
size_t bytesToCopy = uploadBufLength - session.bufPointer;
if (bytesToCopy > length)
{
bytesToCopy = length;
}
memcpy(reinterpret_cast<uint8_t*>(uploadBuffers[session.bufNumber]) + session.bufPointer, request, bytesToCopy);
session.bufPointer += bytesToCopy;
if (session.bufPointer == uploadBufLength)
{
// Switch to the other buffer. We know the rest of the data will fit because the buffer size is bigger than the SPI packet size.
session.bufNumber ^= 1;
if (bytesToCopy < length)
{
memcpy(uploadBuffers[session.bufNumber], request + bytesToCopy, length - bytesToCopy);
}
session.bufPointer = length - bytesToCopy;
// Free up the SPI buffer before we start the file write
if ((fragment & lastFragmentFlag) == 0)
{
network->DiscardMessage();
}
if (session.fileBeingUploaded.Write(reinterpret_cast<const char*>(uploadBuffers[session.bufNumber ^ 1]), uploadBufLength))
{
session.bytesWritten += uploadBufLength;
}
else
{
session.uploadState = cantWrite;
}
}
else if ((fragment & lastFragmentFlag) == 0)
{
network->DiscardMessage(); // free up the SPI buffer
}
}
else if ((fragment & lastFragmentFlag) == 0)
{
network->DiscardMessage(); // free up the SPI buffer
}
++session.nextFragment;
if ((fragment & lastFragmentFlag) != 0)
{
if (session.bufPointer != 0 && session.uploadState == uploading)
{
if (session.fileBeingUploaded.Write(reinterpret_cast<const char*>(uploadBuffers[session.bufNumber]), session.bufPointer))
{
session.bytesWritten += session.bufPointer;
}
else
{
session.uploadState = cantWrite;
}
}
FinishUpload(session);
}
}
// Start a new session for this requester. Return nullptr if on more sessions available.
Webserver::HttpSession *Webserver::StartSession(uint32_t ip)
{
HttpSession *s = FindSession(ip);
if (s != nullptr)
{
// Abandon the existing session for this requester and start a new one
s->nextFragment = 0;
s->fileBeingUploaded.Close(); // TODO delete any partially-uploaded file
return s;
}
// Find an empty session
if (numSessions < maxHttpSessions)
{
s = &sessions[numSessions];
s->ip = ip;
s->isAuthenticated = false;
s->nextFragment = 0;
s->fileBeingUploaded.Close(); // make sure no file is open
s->lastQueryTime = millis();
++numSessions;
return s;
}
return nullptr;
}
// Find an existing session for this requester, returning nullptr if there isn't one
Webserver::HttpSession *Webserver::FindSession(uint32_t ip)
{
for (size_t i = 0; i < numSessions; ++i)
{
HttpSession *s = &sessions[i];
if (s->ip == ip)
{
s->lastQueryTime = millis();
return s;
}
}
return nullptr;
}
// Delete a session
void Webserver::DeleteSession(uint32_t ip)
{
for (size_t i = 0; i < numSessions; ++i)
{
HttpSession *s = &sessions[i];
if (s->ip == ip)
{
s->fileBeingUploaded.Close(); // TODO delete it as well
for (size_t j = i + 1; j < numSessions; ++j)
{
memcpy(&sessions[j - 1], &sessions[j], sizeof(HttpSession));
}
--numSessions;
break;
}
}
if (uploadIp == ip)
{
uploadIp = 0; // free the upload buffer
}
}
void Webserver::Exit()
{
platform->Message(GENERIC_MESSAGE, "Webserver class exited.\n");
webserverActive = false;
}
void Webserver::ResetState()
{
clientPointer = 0;
state = doingFilename;
numQualKeys = 0;
processingDeferredRequest = false;
}
void Webserver::Diagnostics(MessageType mtype)
{
platform->Message(mtype, "=== Webserver ===\n");
platform->MessageF(mtype, "HTTP sessions: %d of %d\n", numSessions, maxHttpSessions);
}
bool Webserver::GCodeAvailable(const WebSource source) const
{
switch (source)
{
case WebSource::HTTP:
return gcodeReadIndex != gcodeWriteIndex;
case WebSource::Telnet:
// Telnet not supported
return false;
}
return false;
}
char Webserver::ReadGCode(const WebSource source)
{
switch (source)
{
case WebSource::HTTP:
if (gcodeReadIndex != gcodeWriteIndex)
{
char c = gcodeBuffer[gcodeReadIndex];
gcodeReadIndex = (gcodeReadIndex + 1u) % gcodeBufferLength;
return c;
}
break;
case WebSource::Telnet:
// Telnet not supported
return 0;
}
return 0;
}
void Webserver::HandleGCodeReply(const WebSource source, OutputBuffer *reply)
{
switch (source)
{
case WebSource::HTTP:
if (reply != nullptr)
{
if (numSessions > 0)
{
// FIXME: This might cause G-code responses to be sent twice to fast HTTP clients, but
// I (chrishamm) cannot think of a nicer way to deal with slow clients at the moment...
gcodeReply->Push(reply);
clientsServed = 0;
seq++;
}
else
{
// Don't use buffers that may never get released...
OutputBuffer::ReleaseAll(reply);
}
}
break;
case WebSource::Telnet:
// Telnet not supported
default:
OutputBuffer::ReleaseAll(reply);
break;
}
}
void Webserver::HandleGCodeReply(const WebSource source, const char *reply)
{
switch (source)
{
case WebSource::HTTP:
if (numSessions > 0)
{
OutputBuffer *buffer = gcodeReply->GetLastItem();
if (buffer == nullptr || buffer->IsReferenced())
{
if (!OutputBuffer::Allocate(buffer))
{
// No more space available, stop here
return;
}
gcodeReply->Push(buffer);
}
buffer->cat(reply);
seq++;
}
break;
case WebSource::Telnet:
default:
break;
}
}
//----------------------------------------------------------------------------------------------------
// Return the value of the specified key, or nullptr if not present
const char* Webserver::GetKeyValue(const char *key) const
{
for (size_t i = 0; i < numQualKeys; ++i)
{
if (StringEquals(qualifiers[i].key, key))
{
return qualifiers[i].value;
}
}
return nullptr;
}
// Process the first fragment of input from the client.
// Return true if the session should be kept open.
bool Webserver::ProcessFirstFragment(HttpSession& session, const char* command, bool isOnlyFragment)
{
// Process connect messages first
if (StringEquals(command, "connect") && GetKeyValue("password") != nullptr)
{
OutputBuffer *response;
if (OutputBuffer::Allocate(response))
{
if (session.isAuthenticated || reprap.CheckPassword(GetKeyValue("password")))
{
// Password is OK, see if we can update the current RTC date and time
const char *timeVal = GetKeyValue("time");
if (timeVal != nullptr && !platform->IsDateTimeSet())
{
struct tm timeInfo;
memset(&timeInfo, 0, sizeof(timeInfo));
if (strptime(timeVal, "%Y-%m-%dT%H:%M:%S", &timeInfo) != nullptr)
{
time_t newTime = mktime(&timeInfo);
platform->SetDateTime(newTime);
}
}
// Client has logged in
session.isAuthenticated = true;
response->printf("{\"err\":0,\"sessionTimeout\":%u,\"boardType\":\"%s\"}", httpSessionTimeout, platform->GetBoardString());
}
else
{
// Wrong password
response->copy("{\"err\":1}");
}
network->SendReply(session.ip, 200 | rcJson, response);
}
else
{
// If we failed to allocate an output buffer, send back an error string
network->SendReply(session.ip, 200 | rcJson, "{\"err\":2}");
}
return false;
}
if (StringEquals(command, "disconnect"))
{
network->SendReply(session.ip, 200 | rcJson, "{\"err\":0}");
DeleteSession(session.ip);
return false;
}
// Try to authorise the user automatically to retain compatibility with the old web interface
if (!session.isAuthenticated && reprap.NoPasswordSet())
{
session.isAuthenticated = true;
}
// If the client is still not authenticated, stop here
if (!session.isAuthenticated)
{
network->SendReply(session.ip, 500, "Not authorized");
return false;
}
if (StringEquals(command, "reply"))
{
SendGCodeReply(session);
return false;
}
// rr_configfile sends the config as plain text well
if (StringEquals(command, "configfile"))
{
const char *configPath = platform->GetMassStorage()->CombineName(platform->GetSysDir(), platform->GetConfigFile());
char fileName[FILENAME_LENGTH];
strncpy(fileName, configPath, FILENAME_LENGTH);
SendFile(fileName, session);
return false;
}
if (StringEquals(command, "download") && GetKeyValue("name") != nullptr)
{
SendFile(GetKeyValue("name"), session);
return false;
}
if (StringEquals(command, "upload"))
{
const char* nameVal = GetKeyValue("name");
const char* lengthVal = GetKeyValue("length");
const char* timeVal = GetKeyValue("time");
if (nameVal != nullptr && lengthVal != nullptr)
{
// Try to obtain the last modified time
time_t fileLastModified = 0;
struct tm timeInfo;
memset(&timeInfo, 0, sizeof(timeInfo));
if (timeVal != nullptr && strptime(timeVal, "%Y-%m-%dT%H:%M:%S", &timeInfo) != nullptr)
{
fileLastModified = mktime(&timeInfo);
}
// Deal with file upload request
uint32_t fileLength = atol(lengthVal);
StartUpload(session, nameVal, fileLength, fileLastModified);
if (session.uploadState == uploading)
{
if (isOnlyFragment)
{
FinishUpload(session);
return false;
}
else
{
network->DiscardMessage(); // no reply needed yet
return true; // expecting more data
}
}
}
network->SendReply(session.ip, 200 | rcJson, "{\"err\":1}"); // TODO return the cause of the error
return false;
}
if (StringEquals(command, "move"))
{
const char* response = "{\"err\":1}"; // assume failure
const char* oldVal = GetKeyValue("old");
const char* newVal = GetKeyValue("new");
if (oldVal != nullptr && newVal != nullptr)
{
bool success = platform->GetMassStorage()->Rename(oldVal, newVal);
if (success)
{
response = "{\"err\":0}";
}
}
network->SendReply(session.ip, 200 | rcJson, response);
return false;
}
if (StringEquals(command, "mkdir"))
{
const char* response = "{\"err\":1}"; // assume failure
const char* dirVal = GetKeyValue("dir");
if (dirVal != nullptr)
{
bool ok = (platform->GetMassStorage()->MakeDirectory(dirVal));
if (ok)
{
response = "{\"err\":0}";
}
}
network->SendReply(session.ip, 200 | rcJson, response);
return false;
}
if (StringEquals(command, "delete"))
{
const char* response = "{\"err\":1}"; // assume failure
const char* nameVal = GetKeyValue("name");
if (nameVal != nullptr)
{
bool ok = platform->GetMassStorage()->Delete("0:/", nameVal);
if (ok)
{
response = "{\"err\":0}";
}
}
network->SendReply(session.ip, 200 | rcJson, response);
return false;
}
// The remaining commands use an OutputBuffer for the response
OutputBuffer *response = nullptr;
if (StringEquals(command, "status"))
{
const char* typeVal = GetKeyValue("type");
if (typeVal != nullptr)
{
// New-style JSON status responses
int type = atoi(typeVal);
if (type < 1 || type > 3)
{
type = 1;
}
response = reprap.GetStatusResponse(type, ResponseSource::HTTP);
}
else
{
response = reprap.GetLegacyStatusResponse(1, 0);
}
}
else if (StringEquals(command, "gcode"))
{
const char* gcodeVal = GetKeyValue("gcode");
if (gcodeVal != nullptr)
{
LoadGcodeBuffer(gcodeVal);
if (OutputBuffer::Allocate(response))
{
response->printf("{\"buff\":%u}", GetGCodeBufferSpace());
}
}
else
{
network->SendReply(session.ip, 200 | rcJson, "{\"err\":1}");
return false;
}
}
else if (StringEquals(command, "filelist") && GetKeyValue("dir") != nullptr)
{
response = reprap.GetFilelistResponse(GetKeyValue("dir"));
}
else if (StringEquals(command, "files"))
{
const char* dir = GetKeyValue("dir");
if (dir == nullptr)
{
dir = platform->GetGCodeDir();
}
const char* flagDirsVal = GetKeyValue("flagDirs");
bool flagDirs = flagDirsVal != nullptr && atoi(flagDirsVal) == 1;
response = reprap.GetFilesResponse(dir, flagDirs);
}
else if (StringEquals(command, "fileinfo"))
{
const char* nameVal = GetKeyValue("name");
if (reprap.GetPrintMonitor()->GetFileInfoResponse(nameVal, response))
{
processingDeferredRequest = false;
}
else
{
processingDeferredRequest = true;
}
}
else if (StringEquals(command, "config"))
{
response = reprap.GetConfigResponse();
}
else
{
platform->MessageF(HOST_MESSAGE, "KnockOut request: %s not recognised\n", command);
network->SendReply(session.ip, 400, "Unknown rr_ command");
return false;
}
if (response != nullptr)
{
network->SendReply(session.ip, 200 | rcJson, response);
}
else if (!processingDeferredRequest)
{
network->SendReply(session.ip, 500, "No buffer available");
}
return processingDeferredRequest;
}
void Webserver::SendGCodeReply(HttpSession& session)
{
if (gcodeReply->IsEmpty())
{
network->SendReply(session.ip, 200, "");
}
else
{
clientsServed++;
if (clientsServed < numSessions)
{
gcodeReply->IncreaseReferences(1);
network->SendReply(session.ip, 200, gcodeReply->GetFirstItem());
}
else
{
network->SendReply(session.ip, 200, gcodeReply->Pop());
}
if (reprap.Debug(moduleWebserver))
{
platform->MessageF(HOST_MESSAGE, "Serving client %d of %d\n", clientsServed, numSessions);
}
}
}
void Webserver::SendFile(const char *nameOfFileToSend, HttpSession& session)
{
FileStore *file = platform->GetFileStore(FS_PREFIX, nameOfFileToSend, false);
if (file == nullptr)
{
network->SendReply(session.ip, 400, "File not found");
}
else
{
// Send an initial message containing the response code and the file size (needed for the Content-length field)
network->SendReply(session.ip, 200, file); // tell the network layer to send the file
}
}
// Process a character from the client
// Rewritten as a state machine by dc42 to increase capability and speed, and reduce RAM requirement.
// On entry:
// There is space for at least 1 character in clientMessage.
// On return:
// If we return false:
// We want more characters. There is space for at least 1 character in clientMessage.
// If we return true:
// We have finished processing the message. No more characters may be read from this message.
// Whenever this calls ProcessMessage:
// The first line has been split up into words. Variables numCommandWords and commandWords give the number of words we found
// and the pointers to each word. The second word is treated specially. It is assumed to be a filename followed by an optional
// qualifier comprising key/value pairs. Both may include %xx escapes, and the qualifier may include + to mean space. We store
// a pointer to the filename without qualifier in commandWords[1]. We store the qualifier key/value pointers in array 'qualifiers'
// and the number of them in numQualKeys.
// The remaining lines have been parsed as header name/value pairs. Pointers to them are stored in array 'headers' and the number
// of them in numHeaders.
// If one of our arrays is about to overflow, or the message is not in a format we expect, then we call RejectMessage with an
// appropriate error code and string.
bool Webserver::CharFromClient(char c, const char* &error)
{
switch(state)
{
case doingFilename:
switch(c)
{
case '\0':
case ' ':
case '\t':
case '\n':
case '\r':
clientMessage[clientPointer++] = 0;
numQualKeys = 0;
error = nullptr;
return true;
case '?':
clientMessage[clientPointer++] = 0;
numQualKeys = 0;
qualifiers[0].key = clientMessage + clientPointer;
state = doingQualifierKey;
break;
case '%':
state = doingFilenameEsc1;
break;
default:
clientMessage[clientPointer++] = c;
break;
}
break;
case doingQualifierKey:
switch(c)
{
case '=':
clientMessage[clientPointer++] = 0;
qualifiers[numQualKeys].value = clientMessage + clientPointer;
++numQualKeys;
state = doingQualifierValue;
break;
case '\n': // key with no value
case ' ':
case '\t':
case '\r':
case '%': // none of our keys needs escaping, so treat an escape within a key as an error
case '&': // key with no value
error = "bad qualifier key";
return true;
default:
clientMessage[clientPointer++] = c;
break;
}
break;
case doingQualifierValue:
switch(c)
{
case '\0':
case '\n':
case ' ':
case '\t':
case '\r':
clientMessage[clientPointer++] = 0;
qualifiers[numQualKeys].key = clientMessage + clientPointer; // so that we can read the whole value even if it contains a null
error = nullptr;
return true;
case '%':
state = doingQualifierValueEsc1;
break;
case '&':
// Another variable is coming
clientMessage[clientPointer++] = 0;
qualifiers[numQualKeys].key = clientMessage + clientPointer; // so that we can read the whole value even if it contains a null
if (numQualKeys < maxQualKeys)
{
state = doingQualifierKey;
}
else
{
error = "too many keys in qualifier";
return true;
}
break;
case '+':
clientMessage[clientPointer++] = ' ';
break;
default:
clientMessage[clientPointer++] = c;
break;
}
break;
case doingFilenameEsc1:
case doingQualifierValueEsc1:
if (c >= '0' && c <= '9')
{
decodeChar = (c - '0') << 4;
state = (HttpState)(state + 1);
}
else if (c >= 'A' && c <= 'F')
{
decodeChar = (c - ('A' - 10)) << 4;
state = (HttpState)(state + 1);
}
else
{
error = badEscapeResponse;
return true;
}
break;
case doingFilenameEsc2:
case doingQualifierValueEsc2:
if (c >= '0' && c <= '9')
{
clientMessage[clientPointer++] = decodeChar | (c - '0');
state = (HttpState)(state - 2);
}
else if (c >= 'A' && c <= 'F')
{
clientMessage[clientPointer++] = decodeChar | (c - ('A' - 10));
state = (HttpState)(state - 2);
}
else
{
error = badEscapeResponse;
return true;
}
break;
}
if (clientPointer == ARRAY_SIZE(clientMessage))
{
error = overflowResponse;
return true;
}
return false;
}
void Webserver::CheckSessions()
{
// Check if any HTTP session can be purged
const uint32_t time = millis();
for (size_t i = 0; i < numSessions; ++i)
{
if ((time - sessions[i].lastQueryTime) > httpSessionTimeout)
{
DeleteSession(sessions[i].ip);
clientsServed++; // assume the disconnected client hasn't fetched the G-Code reply yet
}
}
// If we cannot send the G-Code reply to anyone, we may free up some run-time space by dumping it
if (numSessions == 0 || clientsServed >= numSessions)
{
while (!gcodeReply->IsEmpty())
{
OutputBuffer::ReleaseAll(gcodeReply->Pop());
}
clientsServed = 0;
}
}
// Process a received string of gcodes
void Webserver::LoadGcodeBuffer(const char* gc)
{
char gcodeTempBuf[GCODE_LENGTH];
uint16_t gtp = 0;
bool inComment = false;
for (;;)
{
char c = *gc++;
if (c == 0)
{
gcodeTempBuf[gtp] = 0;
ProcessGcode(gcodeTempBuf);
return;
}
if (c == '\n')
{
gcodeTempBuf[gtp] = 0;
ProcessGcode(gcodeTempBuf);
gtp = 0;
inComment = false;
}
else
{
if (c == ';')
{
inComment = true;
}
if (gtp == ARRAY_UPB(gcodeTempBuf))
{
// gcode is too long, we haven't room for another character and a null
if (c != ' ' && !inComment)
{
platform->Message(HOST_MESSAGE, "Error: GCode local buffer overflow in HTTP webserver.\n");
return;
}
// else we're either in a comment or the current character is a space.
// If we're in a comment, we'll silently truncate it.
// If the current character is a space, we'll wait until we see a non-comment character before reporting an error,
// in case the next character is end-of-line or the start of a comment.
}
else
{
gcodeTempBuf[gtp++] = c;
}
}
}
}
// Process a null-terminated gcode
// We intercept one M Codes so we can deal with emergencies. That
// way things don't get out of sync, and - as a file name can contain
// a valid G code (!) - confusion is avoided.
void Webserver::ProcessGcode(const char* gc)
{
if (StringStartsWith(gc, "M112") && !isdigit(gc[4])) // emergency stop
{
reprap.EmergencyStop();
gcodeReadIndex = gcodeWriteIndex; // clear the buffer
reprap.GetGCodes()->Reset();
}
else
{
StoreGcodeData(gc, strlen(gc) + 1);
}
}
// Process a received string of gcodes
void Webserver::StoreGcodeData(const char* data, uint16_t len)
{
if (len > GetGCodeBufferSpace())
{
platform->Message(HOST_MESSAGE, "Error: GCode buffer overflow in HTTP Webserver!\n");
}
else
{
uint16_t remaining = gcodeBufferLength - gcodeWriteIndex;
if (len <= remaining)
{
memcpy(gcodeBuffer + gcodeWriteIndex, data, len);
}
else
{
memcpy(gcodeBuffer + gcodeWriteIndex, data, remaining);
memcpy(gcodeBuffer, data + remaining, len - remaining);
}
gcodeWriteIndex = (gcodeWriteIndex + len) % gcodeBufferLength;
}
}
// End
|