File: vsptraining.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (1194 lines) | stat: -rw-r--r-- 47,848 bytes parent folder | download | duplicates (2)
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
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 -  
 -  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
 -  project.
 -  
 -  Copyright (C) 1998-2018 OpenLink Software
 -  
 -  This project is free software; you can redistribute it and/or modify it
 -  under the terms of the GNU General Public License as published by the
 -  Free Software Foundation; only version 2 of the License, dated June 1991.
 -  
 -  This program is distributed in the hope that it will be useful, but
 -  WITHOUT ANY WARRANTY; without even the implied warranty of
 -  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 -  General Public License for more details.
 -  
 -  You should have received a copy of the GNU General Public License along
 -  with this program; if not, write to the Free Software Foundation, Inc.,
 -  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 -  
 -  
-->

<sect1 id="vspguide">
<title>VSP Guide</title>

<sect2 id="vspintro"><title>Introduction</title>
  <para>
Virtuoso Server Pages are the equivalent of a stored procedure
in a Web page that is compiled when it is first read by the Virtuoso
server.  Virtuoso detects when  the '.vsp' file is modified
and recompiles the procedure.
Since VSP is essentially Virtuoso PL in a Web page you can do anything
that PL can, either directly or from interaction with the user.
VSP gives you the advantage of not having to worry about making
connections to the database. You also avoid the overhead of RPCs
because the HTTP server is built into Virtuoso.  When you write a VSP page the
connection is automatic since you are already in Virtuoso.
</para>
  <para>
VSP is server script and is therefore executed in the server as it is
encountered on the page.  For this reason client (JavaScript) and server
script cannot directly interact but can supplement each other.  You can
call JavaScript inside a VSP loop, for example, to manipulate something
that already exists on the page but you cannot pass variables by reference
from VSP directly to JavaScript or vice versa.
</para>
  <para>
Page flow control can be managed using FORMs.  The state of the page is
defined in form fields such as INPUT boxes and TEXTAREA boxes and then
passed to the next form or page using POST.
</para>
</sect2>

<sect2 id="htmlusage">
<title>Simple HTML FORM usage</title>

  <para>
We start with a small example that shows the source of a page including a
FORM with data from the user being sent when a submit button is pressed.
We then examine the elements and attributes of this simple form that are
important to us at this stage.
</para>

<sect3 id="basicform"><title>Basic Forms</title>

<example><title>Simple Forms</title>
<programlisting>
&lt;HTML&gt;
  &lt;HEAD&gt;
    &lt;TITLE&gt;Simple FORM demo&lt;/TITLE&gt;
  &lt;/HEAD&gt;
  &lt;BODY&gt;
  &lt;FORM METHOD=&quot;POST&quot; ACTION=&quot;formdemo_receiver.vsp&quot;&gt;
    &lt;P&gt;Test form, type some info and click Submit&lt;/P&gt;
    &lt;INPUT TYPE=&quot;TEXT&quot; NAME=&quot;myInput&quot; /&gt;
    &lt;INPUT TYPE=&quot;SUBMIT&quot; NAME=&quot;submit&quot; VALUE=&quot;Submit&quot; /&gt;
  &lt;/FORM&gt;
  &lt;/BODY&gt;
&lt;/HTML&gt;
</programlisting>
</example>
  <para>
The METHOD attribute of a FORM TAG in a VSP page can be either GET or POST.  The GET method allows the form submission to
be contained completely in a URL; this can be advantageous because it permits bookmarking in browsers,
but it also prevents form data from containing non

ASCII characters such as accented letters and special symbols
and restricts the amount of form data that can be handled.  The GET method is l



mited by the maximum length of the URL that the
server and browser can process. To be safe, any form whose input might contain non-ASCII
characters or more than 100 characters should use METHOD=&quot;POST&quot;.
</para>
  <para>
With the POST method, the form input is submitted as an HTTP POST request with the form data sent in the
body of the request.  Most current browsers are unable to bookmark POST requests,
but POST does not entail the character encoding and length restrictions imposed by GET.
</para>
  <para>
The ACTION attribute of FORM specifies the URI of the form handler.  This will usually be another web page that
performs some action based on the data that is sent from the originating form.  The URI could point to the same page
as the data originated and for pages that perform a well-defined small set of functions it usually does.
When a page needs to manage multiple states there needs to be some flow control that can determine how the page
was reached; for example, to differentiate whether it arrived at as a result of someone clicking on the submit button or it is the first time the page has
been visited.
</para>
</sect3>

<sect3 id="formvalues"><title>Exchanging Values in Forms</title>
  <para>
Now we add some VSP to check the values of the parameters in the form.  VSP markup is typically
contained in &lt;?vsp ... ?&gt; blocks.
</para>

<example><title>Forms and Values</title>
<programlisting>
&lt;HTML&gt;
  &lt;HEAD&gt;
    &lt;TITLE&gt;Simple FORM demo&lt;/TITLE&gt;
  &lt;/HEAD&gt;
  &lt;BODY&gt;
  &lt;P&gt;Last value sent:

  &lt;?vsp
    http(get_keyword('myInput', params, 'no value'));
   ?&gt;

&lt;/P&gt;

  &lt;FORM METHOD=&quot;POST&quot; ACTION=&quot;formdemo.vsp&quot;&gt;
    &lt;P&gt;Test form, type some info and click Submit&lt;/P&gt;
    &lt;INPUT TYPE=&quot;TEXT&quot; NAME=&quot;myInput&quot; /&gt;
    &lt;INPUT TYPE=&quot;SUBMIT&quot; NAME=&quot;submit&quot; VALUE=&quot;Submit&quot; /&gt;
  &lt;/FORM&gt;
  &lt;/BODY&gt;
&lt;/HTML&gt;
</programlisting>
</example>
  <para>
This is the same example as above but now it uses the same page for the
form handler and displays the parameters each time.  Clicking the Submit
button takes you to the same page and displays whatever you typed in
the field last time.
</para>
  <para>
The VSP block uses two nested functions.  The <function>http()</function>
function allows you to send data to the HTTP client, the browser.
What we send to the browser is the result of the <function>get_keyword()</function>
function, which has three parameters:
<parameter>search_for</parameter>, <parameter>source_array</parameter>,
and <parameter>default_val</parameter>.  It searches
for the keyword-value pair (keyword=value) where the keyword matches
the <parameter>search_for</parameter> parameter (in this case 'myInput')
in the array passed in the <parameter>source_array</parameter> parameter.
It returns the value
if one is found; otherwise returns the <parameter>default_val</parameter> parameter in the
function, in this case 'no value'.
The<parameter> params</parameter> argument is a special array that contains
all page parameters from the previous FORM state.
</para>
</sect3>

<sect3 id="formandvspconditions"><title>Conditional Processing</title>

  <para>
Now we extend this further to add some conditional control so that
if a value was entered we can respond directly to it.
We will also use a variable this time, which must be declared first.
</para>

<example><title>Conditional Processing Using IF</title>
<programlisting>
&lt;HTML&gt;
  &lt;HEAD&gt;
    &lt;TITLE&gt;Simple FORM demo&lt;/TITLE&gt;
  &lt;/HEAD&gt;
  &lt;BODY&gt;

  &lt;?vsp
	declare _myInput varchar;

	_myInput := get_keyword('myInput', params, '');

    if (_myInput &lt;&gt; '')
	{	http('&lt;P&gt;Hello, ');
		http(_myInput);
		http('&lt;/P&gt;');
	}
	else
	{	http('&lt;P&gt;Please enter your name&lt;/P&gt;');
	}
   ?&gt;

  &lt;FORM METHOD=&quot;POST&quot; ACTION=&quot;formdemo.vsp&quot;&gt;
    &lt;INPUT TYPE=&quot;TEXT&quot; NAME=&quot;myInput&quot; VALUE=&quot;&quot; /&gt;
    &lt;INPUT TYPE=&quot;SUBMIT&quot; NAME=&quot;submit&quot; VALUE=&quot;Submit&quot; /&gt;
  &lt;/FORM&gt;
  &lt;/BODY&gt;
&lt;/HTML&gt;
</programlisting>
</example>
</sect3>

<sect3 id="vsppgctrl"><title>Further Page Control</title>

  <para>
We now extend this to control the whole content of the page.
In this example we see that VSP and HTML can be interleaved.
</para>

<example><title>Page Control</title>
<programlisting>
&lt;HTML&gt;
  &lt;HEAD&gt;
    &lt;TITLE&gt;Simple FORM demo&lt;/TITLE&gt;
  &lt;/HEAD&gt;
  &lt;BODY&gt;

  &lt;?vsp
	declare _myInput varchar;
	declare Mode varchar;

	_myInput := get_keyword('myInput', params, '');
	Mode := get_keyword('submit', params, '');

    if (Mode = 'Submit')
	{
   ?&gt;
    &lt;P&gt;Hello, &lt;?vsp http(_myInput); ?&gt;
	&lt;/P&gt;

&lt;FORM METHOD=&quot;POST&quot; ACTION=&quot;demo4.vsp&quot;&gt;
&lt;INPUT TYPE=&quot;HIDDEN&quot; NAME=&quot;myInput&quot; VALUE=&quot;&quot; /&gt;
&lt;INPUT TYPE=&quot;SUBMIT&quot; NAME=&quot;submit&quot; VALUE=&quot;Again&quot; /&gt;
&lt;/FORM&gt;

  &lt;?vsp
	}
	  else
	{
   ?&gt;

  &lt;P&gt;Please enter you name&lt;/P&gt;
  &lt;FORM METHOD=&quot;POST&quot; ACTION=&quot;demo4.vsp&quot;&gt;
    &lt;INPUT TYPE=&quot;TEXT&quot; NAME=&quot;myInput&quot; /&gt;
    &lt;INPUT TYPE=&quot;SUBMIT&quot; NAME=&quot;submit&quot; VALUE=&quot;Submit&quot; /&gt;
  &lt;/FORM&gt;

  &lt;?vsp
    }
  ?&gt;
  &lt;/BODY&gt;
&lt;/HTML&gt;
</programlisting>
</example>

  <para>We start by setting the mode based on whether the Submit
  button has been pressed.  When the mode has changed a different version of the page
  is sent to the browser.  In the new version, the Again button the appears, to return you
  to the previous state when pressed.</para>
</sect3>

<sect3 id="params"><title>Communicating Parameters Between Pages</title>
<para>Now we will use two pages to do the same job as in the demo above.</para>
<example><title>Using more than one page</title>

<para>Page 1</para>
<programlisting>
<![CDATA[
<HTML>
  <HEAD>
    <TITLE>Multi Page Demo</TITLE>
  </HEAD>
  <BODY>
  <P>Please enter you name</P>
  <FORM METHOD="POST" ACTION="demo5_2.vsp">
    <INPUT TYPE="TEXT" NAME="myInput" />
    <INPUT TYPE="SUBMIT" NAME="submit" VALUE="Submit" />
  </FORM>
  </BODY>
</HTML>
]]>
</programlisting>
<para>Page 2</para>
<programlisting>
<![CDATA[
<HTML>
  <HEAD>
    <TITLE>Multi Page Demo</TITLE>
  </HEAD>
  <BODY>
  <P>The value you entered was:
  <?vsp
    http(get_keyword('submit', params, 'no data'));
  ?>
  </P>
  <FORM METHOD="POST" ACTION="demo5_1.vsp">
    <INPUT TYPE="SUBMIT" NAME="submit" VALUE="Back" />
  </FORM>
  </BODY>
</HTML>
]]>
</programlisting>
</example>
</sect3>

<sect3 id="formsandjs"><title>Using JavaScript to Control Forms</title>
<para>JavaScript is a programming language that can be used in the browser
and is useful for client-side programming.   It is  useful to be able
to do some work on the
client machine before making another round trip to the server for more processing.
JavaScript is also useful for making things more appealing to the Web
page viewer. </para>
<para>JavaScript can be made to respond to events within the browser such as
when the mouse is moved over a link, a graphic or a button or when the mouse is
clicked on some part of the page.  This can be achieved by using event
handlers within the HTML tags and placing JavaScript code in their content.
Common event handlers are <emphasis>onMouseOver</emphasis>, <emphasis>onMouseClick</emphasis>,
<emphasis>onMouseOut</emphasis>, <emphasis>onChange</emphasis>, and the
like.</para>

<para>A simple but useful example of this would be to simplify one of the
previous examples by placing a handler on the text box so that you do not have to
press the submit button to send the form to the server:</para>
<programlisting><![CDATA[
  <FORM METHOD="POST" ACTION="demo5_2.vsp" NAME="demo5_2">
    <INPUT TYPE="TEXT" NAME="myInput" onChange="document.demo5_2.submit()" />
    <INPUT TYPE="SUBMIT" NAME="submit" VALUE="Submit" />
  </FORM>
]]></programlisting>

</sect3>

<!--
<sect3 id="basicvspexamples"><title>Basic VSP Examples</title>
simple interactive forms that bounce some values around (mostly done)
</sect3>
-->
</sect2>

<sect2 id="dbinteraction"><title>Interacting with the Database</title>

<para>This section describes manipulating data within Virtuoso
from VSP.  Unless the required tables already exist, new ones will need to be
created.  This example will involve a simple table of people and a series
of pages for adding, editing, viewing, and deleting its entries.</para>

<sect3 id="basiccreatetable"><title>Creating a Table</title>
<para>Tables should be created so that their entries can be uniquely identified.
This is very important so that if we need to edit or delete one particular entry
we can distinguish it from other entries.  A <emphasis>primary key</emphasis>
is how a database enforces unique rows, by refusing to allow
duplicate data to be inserted.  It is up to the user to choose a column in the
table to act as a primary key.  Sometimes one or more of the columns of data are naturally
unique either singularly or in composite; other times it is necessary
to add a column to contain unique codes for each row.</para>
<tip><title>See Also:</title>
<para><link linkend="pkeycons">Primary Keys</link></para>
</tip>
<para>Here is the definition of the simple table that will be used:</para>
<programlisting>
CREATE TABLE DB.DBA.DEMO_PEOPLE (
  EMAIL VARCHAR(255) PRIMARY KEY,
  FORENAME VARCHAR(100),
  SURNAME VARCHAR(100)
);
</programlisting>
<para>The email address has been selected as a primary key.</para>
</sect3>

<sect3 id="insertingvalues"><title>Basic Form Input Page</title>
<para>After the table has been created; for example via Virtuoso's
iSQL utility; it will need some data.
For this we create a &quot;New Person&quot; page.  This page uses form
inputs and some VSP code to determine whether
an insert button was pressed.  If the insert button is pressed then the
page takes submitted values from the POST and uses them to construct
an SQL statement that inserts a new row into the table.  This is
demonstrated below:</para>
<programlisting><![CDATA[
<HTML>
  <HEAD>
    <TITLE>New Person Page</TITLE>
  </HEAD>
  <BODY>
  <?vsp

    declare _email, _forename, _surname varchar;

    _email := get_keyword('email', params, '');
    _forename := get_keyword('forename', params, '');
    _surname := get_keyword('surname', params, '');

    -- insert new person if we came from the insert button
    if ('' <> get_keyword('ins_button', params, ''))
    {
      INSERT INTO DB.DBA.DEMO_PEOPLE(EMAIL, FORENAME, SURNAME)
        VALUES(_email, _forename, _surname);
    }
  ?>
  <P>Please enter the details of new person:</P>

  <FORM METHOD="POST" ACTION="demo_people_add.vsp">
  <TABLE>
    <TR><TH>Email:</TH><TD><INPUT TYPE="TEXT" NAME="email" /></TD></TR>
    <TR><TH>Forename:</TH><TD><INPUT TYPE="TEXT" NAME="forename" /></TD></TR>
    <TR><TH>Surname:</TH><TD><INPUT TYPE="TEXT" NAME="surname" /></TD></TR>
  </TABLE>

  <INPUT TYPE="SUBMIT" NAME="ins_button" VALUE="Insert" />
  </FORM>

  </BODY>
</HTML>
]]></programlisting>

<para>The underscores were added to this example to keep the param
variables and page variables visibly distinguishable.</para>
</sect3>

<sect3 id="retrtabvals"><title>Displaying Table Data in a VSP Page</title>
<para>Now that some data exists in the table we need a way to
display it.  The FOR ... DO construct is used to construct the insides of
an HTML table:</para>
<programlisting><![CDATA[
<HTML>
  <HEAD>
    <TITLE>The People Page</TITLE>
  </HEAD>
  <BODY>
  <P>The Peoples' Details</P>

  <TABLE>
    <TR><TH>Email</TH><TH>Forename</TH><TH>Surname</TH></TR>
  <?vsp
    FOR (SELECT EMAIL, FORENAME, SURNAME FROM DB.DBA.DEMO_PEOPLE) DO
    {
  ?>
    <TR><TD><?=EMAIL?></TD><TD><?=FORENAME?></TD><TD><?=SURNAME?></TD></TR>
  <?vsp
    }
  ?>
  </TABLE>
  </BODY>
</HTML>
]]></programlisting>
</sect3>

<sect3 id="deletevals"><title>Simple Form Delete Page</title>
<para>The page above can easily be extended to allow deletion.  For each row an 'action' link is added.  The action
Remove link hardwires a form GET on the URL.  This is then
intercepted by the IF condition looking for the <parameter>remove</parameter> parameter. </para>
<programlisting><![CDATA[
<HTML>
  <HEAD>
    <TITLE>The People Page With Deletion</TITLE>
  </HEAD>
  <BODY>
  <?vsp
    declare deleteme varchar;

    deleteme := get_keyword('remove', params, '');
    if ('' <> deleteme)
      DELETE FROM DB.DBA.DEMO_PEOPLE WHERE EMAIL = deleteme;
  ?>

  <FORM METHOD="POST" ACTION="demo_people_view2.vsp">
  <P>The Peoples' Details</P>

  <TABLE>
    <TR><TH>Email</TH><TH>Forename</TH><TH>Surname</TH>
      <TH>Action</TH></TR>
  <?vsp
    FOR (SELECT EMAIL, FORENAME, SURNAME FROM DB.DBA.DEMO_PEOPLE) DO
    {
  ?>
    <TR><TD><?=EMAIL?></TD><TD><?=FORENAME?></TD><TD><?=SURNAME?></TD>
      <TD><A HREF="?remove=<?=EMAIL?>">Remove</A></TD></TR>
  <?vsp
    }
  ?>
  </TABLE>
  </FORM>
  </BODY>
</HTML>
]]></programlisting>
</sect3>

<sect3 id="editvals"><title>Simple Form Edit Page</title>
<para>The last step is to have a way to edit rows of the
table.  To do this, we combine everything that we have so far
and use the SQL UPDATE statement to update the row.  The EMAIL
column is not made updateable since this is the primary key.
</para>
<programlisting><![CDATA[
<HTML>
  <HEAD>
    <TITLE>The People Page With Deletion</TITLE>
  </HEAD>
  <BODY>
  <FORM METHOD="POST" ACTION="demo_people_view3.vsp">
  <?vsp
    declare deleteme, editme, edt_email, edt_forename, edt_surname,
            save_email, save_forename, save_surname varchar;

    deleteme := get_keyword('remove', params, '');
    if ('' <> deleteme)
      DELETE FROM DB.DBA.DEMO_PEOPLE WHERE EMAIL = deleteme;

    if ('' <> get_keyword('save_button', params, ''))
    {
      save_email := get_keyword('email', params, '');
      save_forename := get_keyword('forename', params, '');
      save_surname := get_keyword('surname', params, '');

      update DB.DBA.DEMO_PEOPLE
        SET FORENAME = save_forename, SURNAME=save_surname
        WHERE EMAIL = save_email ;
    }

    editme := get_keyword('edit', params, '');
    if ('' <> editme)
    {
      SELECT EMAIL, FORENAME, SURNAME
        INTO edt_email, edt_forename, edt_surname
        FROM DB.DBA.DEMO_PEOPLE WHERE EMAIL = editme;
  ?>
  <TABLE>
    <TR><TH>Email:</TH><TD><INPUT DISABLED TYPE="TEXT" NAME="email" VALUE="<?=edt_email?>" /></TD></TR>
    <TR><TH>Forename:</TH><TD><INPUT TYPE="TEXT" NAME="forename" VALUE="<?=edt_forename?>" /></TD></TR>
    <TR><TH>Surname:</TH><TD><INPUT TYPE="TEXT" NAME="surname" VALUE="<?=edt_surname?>" /></TD></TR>
  </TABLE>
  <INPUT TYPE="SUBMIT" NAME="save_button" VALUE="Save" />
  <?vsp
    }
  ?>

  <P>The Peoples' Details</P>

  <TABLE>
    <TR><TH>Email</TH><TH>Forename</TH><TH>Surname</TH>
      <TH>Action</TH></TR>
  <?vsp
    FOR (SELECT EMAIL, FORENAME, SURNAME FROM DB.DBA.DEMO_PEOPLE) DO
    {
  ?>
    <TR><TD><?=EMAIL?></TD><TD><?=FORENAME?></TD><TD><?=SURNAME?></TD>
      <TD><A HREF="?remove=<?=EMAIL?>">Remove</A> <A HREF="?edit=<?=EMAIL?>">Edit</A></TD></TR>
  <?vsp
    }
  ?>
  </TABLE>
  </FORM>
  </BODY>
</HTML>
]]></programlisting>
</sect3>

</sect2>


<!--
Data Validity
Table constraints
Trapping Errors
Datatype traps and avoidance (coalesce)

Free Text

XML

XSL
-->
<!-- ############################################# -->

<!--
<sect2 id="tut_web_basic_vsp"><title>Basic VSP Programming</title>
&vs_b_1; &vs_b_2; &vs_b_3; &vs_b_4; &vs_b_5; &vs_b_6; &vs_b_7; &vs_b_8; &vs_b_9;
</sect2>

<sect2 id="tut_web_special_ctrl"><title>Special Control Functions</title>
&vs_c_1;
</sect2>

<sect2 id="tut_web_dav_maint"><title>DAV Maintenance</title>
&vs_d_1; &vs_d_2; &vs_d_3; &vs_d_4; &vs_d_5; &vs_d_6; &vs_d_7; &vs_d_8;
</sect2>
-->

<!-- ############################################# -->

<sect2 id="vspforumsapp"><title>The Forums Application</title>
<para>
The "Forums" Application is a World Wide Web Application for posting, reading
and searching of messages developed under the Virtuoso VDBMS with a wide usage
of Virtuoso Server Pages (VSP) and server-side XSL-T transformation.
</para>
  <para>
Messages in the forums are classified to forums and sub-forums by
interest.  Posting is only allowed for registered users.  Registration is
performed via a registration form.  Every registered user can create new a
theme, post new messages to an existing theme or reply to an existing
message.  Unregistered users can only search, browse, and read existing
themes and messages.
</para>
<sect3 id="forumsprinciples"><title>Principles</title>
<para>
The application is based on VSPs, XML and XSLT transformations.  The
VSPs are used to produce XML documents that are transformed to HTML using
server side XSLT.  The design and appearance of the
application depends solely on XSLT style sheets.  This allows us to divide
the development into two distinct parts: layout and design, and
functionality of the application.
</para>
  <para>
Session management is based on URL manipulation and persistent HTTP session
variables.  The messages are stored in Database as XML documents with a free-text
index applied over them.
</para>
</sect3>

<sect3 id="forumsnav"><title>Navigation</title>

<para>
The application consists of four main pages:
</para>

<orderedlist>
<listitem><para><emphasis>home.vsp</emphasis> - the main page introduces the
forums with the following information:</para>
  <simplelist>
	  <member>Forums: name of each forum with link to the relevant sub-forums.</member>
	  <member>Total: total number of messages for this forum.</member>
		<member>New: new messages for this forum within the last day.</member>
		<member>Last: number of the last message inserted in the forum.</member>
		<member>Total users: count of registered users.</member>
		<member>Options: login if the user is already registered in the forums.</member>
		<member>Registration: add a new user.</member>
		<member>Search: search in the messages.</member>
  </simplelist>
</listitem>

<listitem><para><emphasis>subforums.vsp</emphasis> - sub-forums
of the current forum with the following information:</para>
<simplelist>
<member>Subforum: name of each sub-forum with links to relevant themes.</member>
<member>Total: total number of messages for this forum.</member>
<member>New: new messages for this forum within the last day.</member>
<member>Last: number of the last message inserted in the forum.</member>
  <member>Options: login if the user is already registered in the forums.</member>
	<member>Registration: add a new user</member>
	<member>Search: search in the messages.</member>
	<member>Forums path: links to the home page and to the forum to
	which the current sub-forums belong.</member>
</simplelist>
</listitem>

<listitem>
  <para><emphasis>forum.vsp</emphasis> - themes of the current
	sub-forum with the following information:</para>
  <simplelist>
	  <member>Theme: name of each theme with links to its messages.</member>
		<member>Total: total number of messages for this theme.</member>
		<member>New: new messages for this theme within the last day.</member>
		<member>Last: number of the last message inserted in the theme.</member>
	  <member>Options: login if the user is already registered in the forums.</member>
		<member>Registration: add a new user.</member>
		<member>Search: search in the messages.</member>
		<member>Forums path: links to the home page, to the forum and to the
		sub-forum to which the current themes belong.</member>
	</simplelist>
</listitem>

<listitem>
  <para><emphasis>thread.vsp</emphasis> - messages of the current
	theme with the following information:</para>

	<simplelist>
	  <member>Message: name of each message with a link to its
 properties.  When the link is activated the same page is presented, but
		with the tree of messages for which the current message is
 the parent.</member>
		<member>Author: the name of the author of the current message.</member>
		<member>Date: posting date of the message.</member>
	  <member>Options: login if the user is already registered in the forums.</member>
		<member>Registration: add a new user.</member>
		<member>Search: search in the messages.</member>
		<member>Forums path: links to the home page, to the forum and to the
		sub-forum to which the current message belongs.  Also for the current
		message, the parent message's name is presented. As users
 move lower in the tree, they can go
		back using this path.</member>
	</simplelist>
</listitem></orderedlist>
</sect3>

<sect3 id="forumsremarks"><title>Remarks</title>

<para>
The basic principles of the application's implementation are:
</para>
<simplelist>
<member>The result of a VSP execution is a well-formed XML document.</member>
<member>Use the Virtuoso server to do server-side XSLT transformations
with appropriate style sheets whenever needed.</member>
<member>Use URL manipulations for session management.</member>
<member>Use post-processing functions to provide commonly used
parameters (such as user ID) as session variables.</member>
</simplelist>

<para>
If users are not logged in they can access all pages of the site, but if
they want to insert a new theme or create a new message, they have to log
in.  When users attempt to create or insert, they will be prompted with
the login page.  When they log in, the forums application will take them
directly to the form for inserting messages or themes.
If users are not logged in, the name 'anonymous' is displayed, instead of
the e-mail address that would be displayed if they were logged in.
</para>

</sect3>

<sect3 id="forumssrchpg"><title>The Search Page</title>
<para>Users can search in three ways:</para>
	<simplelist>
	  <member>Theme title: titles of message that are titles of themes.</member>
		<member>Message title: titles of message that have the current theme as parent.</member>
		<member>Message body: bodies of messages that have different themes as parents.</member>
	</simplelist>

	<para>Search results contain information about how many hits were
	found, and for each hit the following:</para>
	<simplelist>
	  <member>Message title: the title of the current message.  When you search
		in message bodies, the message titles are displayed.</member>
		<member>Time: date the message or theme was inserted.</member>
		<member>Author: author of the message or theme.</member>
	</simplelist>

  <para>
	The search page provides the interface for searching contents of forums
	including messages and titles.</para>

<programlisting>
&lt;?vsp
  declare id, acount, aresults integer;
  declare aquery, awhat, askiped, search_res, sid, uid, url, usr varchar;

  -- &gt; at this point we instruct server to do server-side XSLT transformation
	-- &gt;    over resultant document
  -- &gt; The transformation will be done before sending the document to the user-agent
  -- &gt;    and after page execution is done.
	-- &gt; To provide flexible file location we use a registry setting for XSLT
	-- &gt;    style sheets
  http_xslt(sprintf ('file:%s/search.xsl', registry_get ('app_forums_xslt_location')));

  -- &gt; because the application does URL poisoning for session management
  -- &gt; we must retrieve the request parameters:

  -- &gt; the session ID
  sid      := get_keyword('sid', params, '0');
  -- &gt; the query text
  aquery   := get_keyword('q',params,'');
  -- &gt; the query locator (for what we searching)
  awhat    := get_keyword('wh',params,'t');
  -- &gt; how many records to skip
  askiped  := atoi (get_keyword('sk',params,'0'));
  -- &gt; how many results to return
  aresults := atoi (get_keyword('rs',params,'10'));
  -- &gt; hits count
  acount   := atoi (get_keyword('c',params,'0'));

  url := 'thread.vsp';

  -- &gt; also we get the user ID from the session variables
  uid := connection_get ('pid');
  usr := connection_get ('usr');

  -- &gt; now we are ready and call the stored procedure that returns the result from search
  search_res := FORI_SEARCH_RES (aquery, awhat, askiped, aresults, acount);
?&gt;
&lt;!-- now we produce the result as well-formed XML document --&gt;
&lt;?xml version="1.0"?&gt;
&lt;page&gt;
&lt;sid&gt;&lt;?=sid?&gt;&lt;/sid&gt;
&lt;usr&gt;&lt;?=usr?&gt;&lt;/usr&gt;
&lt;url&gt;&lt;?=url?&gt;&lt;/url&gt;
&lt;nav_2&gt;&lt;?vsp http(FORI_SEARCH_FORM (sid, aquery, awhat, askiped, aresults, acount)); ?&gt;&lt;/nav_2&gt;
&lt;css_1/&gt;
&lt;squery&gt;&lt;?=aquery?&gt;&lt;/squery&gt;
&lt;swhat&gt;&lt;?=awhat?&gt;&lt;/swhat&gt;
&lt;sskiped&gt;&lt;?=askiped?&gt;&lt;/sskiped&gt;
&lt;sresults&gt;&lt;?=aresults?&gt;&lt;/sresults&gt;
&lt;scount&gt;&lt;?=acount?&gt;&lt;/scount&gt;
&lt;?vsp http (search_res); ?&gt;
&lt;?vsp http (FORI_SEARCH_NAVIGATION (
  sprintf('search.vsp?q=%s&amp;wh=%s&amp;rs=%d&amp;c=%d&amp;sid=%s&amp;', aquery, awhat, aresults, acount, sid),
	  acount, askiped, aresults)); ?&gt;
&lt;/page&gt;
</programlisting>
</sect3>

<sect3 id="forumssrchdesc"><title>Search Page Analysis</title>
  <para>
	First we declare the variables used inside the page.  In VSP, variables can be
	defined at any time, but it is generally good practice is to declare them
	near the top.
</para>
	<para>
	We call <function>http_xslt()</function> with a file URL parameter.  This instructs the Virtuoso
	server to do XSLT transformation on the server side before sending output
	to the client, and after execution of the page.  Hence we will produce
	an XML document.
</para>
  <para>
	After this we need to get the input parameters session_id, query text,
	how many records to skip, and how many records to display.  We do this
	by calling <function>get_keyword()</function> and passing it the 'params' array.
	Every VSP page has <parameter>params</parameter>,
	<parameter>path</parameter>, and <parameter>lines</parameter> as
	input parameters.  For
	each call we supply a default value in case the variable has not been used.  For
	some of the parameters we need an integer, but varchars are always returned,
	so we use <function>atoi()</function> on the result to convert it to an integer.
</para>
	<para>
	Next we retrieve the persistent variables <parameter>user id</parameter> and <parameter>user name</parameter>.  We do this
	by calling <function>connection_get()</function> with the session variable name.
</para>
  <para>
	After this preparation, we are ready to perform the searching by calling the PL stored procedure
	<function>FORI_SEARCH_RES()</function>.  This procedure returns the XML entities that contain
	the results from the search.
</para>
  <para>
	Once we have results, we want to produce the XML document that will be used in the
	XSLT transformation.  We do this part of the work using the shortcuts to the
	<function>http_value()</function> function: '&lt;?= ?&gt;' pairs, and
	also in some places '&lt;?vsp ?&gt;' to call the <function>FORI_SEARCH_FORM()</function> and
	<function>FORI_SEARCH_NAVIGATION()</function> procedures and
	output their results.
</para>
  <para>
	The main benefits to this approach are:
	</para>
	<simplelist>
	  <member>design independency of VSP content: if we need a different design
		we only need to change the XSLT style sheet;</member>
		<member>different style sheets can represent different
		themes.  If we pass an additional 'theme' parameter, for example, we can
		associate a new theme with a different style sheet.  This way we have a fast
		approach to customizing the look of the page;
		</member>
	  <member>browser independence: because we do server-side XSLT transformation
		we do not need the browser to support XSLT or XML at all.</member>
	</simplelist>
  <para>
	If we comment out the line that instructs
	Virtuoso to perform the XSLT transformation (<function>http_xslt()</function>)
	we will get the following document:
</para>

<programlisting>
&lt;?xml version="1.0"?&gt;
&lt;page&gt;
&lt;sid&gt;0&lt;/sid&gt;
&lt;usr&gt;anonymous&lt;/usr&gt;
&lt;url&gt;thread.vsp&lt;/url&gt;
&lt;nav_2&gt;&lt;search_form&gt;
&lt;hidden&gt;
&lt;hidden_input type="hidden" name="sid" value="0" /&gt;
&lt;hidden_input type="hidden" name="sk" value="0" /&gt;
&lt;hidden_input type="hidden" name="rs" value="10" /&gt;
&lt;hidden_input type="hidden" name="c" value="0" /&gt;
&lt;/hidden&gt;
&lt;select name="wh"&gt;
&lt;option value="t" selected="1"&gt;theme title&lt;/option&gt;
&lt;option value="mt"&gt;message title&lt;/option&gt;
&lt;option value="mb"&gt;message body&lt;/option&gt;
&lt;/select&gt;
&lt;/search_form&gt;
&lt;/nav_2&gt;
&lt;css_1/&gt;
&lt;squery&gt;&lt;/squery&gt;
&lt;swhat&gt;t&lt;/swhat&gt;
&lt;sskiped&gt;0&lt;/sskiped&gt;
&lt;sresults&gt;10&lt;/sresults&gt;
&lt;scount&gt;0&lt;/scount&gt;
&lt;search_result&gt;
&lt;no_hits/&gt;
&lt;/search_result&gt;
&lt;navigation pages="0"&gt;
&lt;/navigation&gt;
&lt;/page&gt;
</programlisting>

<para>If we re-enable the XSLT transformation the user agent will
receive the following HTML content:
</para>

<programlisting>
&lt;html&gt;&lt;head&gt;
&lt;style type="text/css"&gt;
a:hover{color:#a2a2a2}
.id{font-size:12px;font-family:arial,sans-serif;font-weight:bold;color:#004C87}
.ie{font-size:12px;font-family:verdana,sans-serif;color:#FFFFFF}
.ir{font-size:14px;font-weight:bold;font-family:verdana,sans-serif;color:#FFFFFF}
.if{font-size:12px;text-decoration:none;font-family:verdana,sans-serif;
   font-weight:bold;color:#E1F2FE}
.iname{font-size:12px;font-weight:bold;font-family:verdana,sans-serif;color:#FFFFFF}
.ipath{font-size:12px;text-decoration:none;font-weight:bold;
   font-family:verdana,sans-serif;color:#004C87}
.inew {font-size:12px;text-decoration:none;font-weight:bold;
   font-family:verdana,sans-serif;color:#FFC600}
.text {font-size:12px;text-decoration:none;font-family:Arial,sans-serif;color:#004C87}
&lt;/style&gt;
&lt;/head&gt;
  &lt;body&gt;
    &lt;TABLE WIDTH="100%" BGCOLOR="#004C87" CELLPADDING="0" CELLSPACING="0" BORDER="0"&gt;
     &lt;TR&gt;
      &lt;form action="search.vsp" method="post"&gt;
        &lt;TD WIDTH="20%" VALIGN="top"&gt;
          &lt;IMG SRC="i/logo_n.gif" HEIGHT="49" WIDTH="197" BORDER="0"&gt;&lt;/TD&gt;
	&lt;TD WIDTH="40%" ALIGN="center"&gt;
	  &lt;input type="text" name="q" size="36" value=""&gt;&lt;/TD&gt;
	&lt;TD WIDTH="25%" ALIGN="center"&gt;
	   &lt;select name="wh"&gt;
	      &lt;option value="t" selected&gt;theme title&lt;/option&gt;
	      &lt;option value="mt"&gt;message title&lt;/option&gt;
	      &lt;option value="mb"&gt;message body&lt;/option&gt;
	   &lt;/select&gt; &lt;input type="hidden" name="sid" value="0"&gt;
	   &lt;input type="hidden" name="sk" value="0"&gt;
	   &lt;input type="hidden" name="rs" value="10"&gt;
	   &lt;input type="hidden" name="c" value="0"&gt;
	&lt;/TD&gt;
	&lt;TD WIDTH="15%"&gt;
	&lt;input type="image" name="search" src="i/search.gif" border="0"&gt;&lt;/TD&gt;
	&lt;/form&gt;
      &lt;/TR&gt;
   &lt;/TABLE&gt;
    &lt;TABLE WIDTH="100%" BGCOLOR="#02A5E4" CELLPADDING="0" CELLSPACING="0" BORDER="0"&gt;
      &lt;TR&gt;
	&lt;TD&gt;
	    &lt;IMG SRC="i/str.gif" HEIGHT="12" WIDTH="35"&gt;
	    &lt;a class="id" href="home.vsp?sid=0"&gt;Home&lt;/a&gt;
       &lt;/TD&gt;
       &lt;TD HEIGHT="22" class="iname" ALIGN="right"&gt;anonymous &lt;/TD&gt;
      &lt;/TR&gt;
      &lt;/TABLE&gt;
      &lt;TABLE BGCOLOR="#E1F2FE" ALIGN="center" WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"&gt;
       &lt;TR&gt;
         &lt;TD COLSPAN="3"&gt;
 	    &lt;IMG SRC="i/c.gif" HEIGHT="12" WIDTH="1"&gt;
         &lt;/TD&gt;
       &lt;/TR&gt;
       &lt;TR&gt;
        &lt;TR BGCOLOR="#0073CC"&gt;
         &lt;TD WIDTH="60%" HEIGHT="24" class="ie"&gt; message title&lt;/TD&gt;
         &lt;TD WIDTH="20%" class="ie"&gt;time&lt;/TD&gt;
         &lt;TD WIDTH="20%" class="ie"&gt;author&lt;/TD&gt;
       &lt;/TR&gt;
      &lt;TR&gt;
        &lt;TD COLSPAN="3"&gt;
          &lt;IMG SRC="i/c.gif" HEIGHT="2" WIDTH="1"&gt;
        &lt;/TD&gt;
      &lt;/TR&gt;
      &lt;TR&gt;
        &lt;TD align="left" class="id" COLSPAN="3"&gt;No hits found&lt;/TD&gt;
      &lt;/TR&gt;
      &lt;TR&gt;
       &lt;TD HEIGHT="18" colspan="3" BGCOLOR="#0073CC" class="id"&gt;
       &lt;/TD&gt;
      &lt;/TR&gt;
     &lt;/TR&gt;
     &lt;TR&gt;
       &lt;TD COLSPAN="3"&gt;
         &lt;IMG SRC="i/c.gif" HEIGHT="2" WIDTH="1"&gt;
       &lt;/TD&gt;
     &lt;/TR&gt;
     &lt;TR&gt;
      &lt;TD COLSPAN="3" BGCOLOR="#0073CC"&gt;
        &lt;IMG SRC="i/c.gif" HEIGHT="1" WIDTH="1"&gt;
      &lt;/TD&gt;
     &lt;/TR&gt;
    &lt;/TABLE&gt;
  &lt;/body&gt;
&lt;/html&gt;
</programlisting>

	<para>The page sources are available in the default distribution under the
	samples directory.</para>

	<tip><title>See Also:</title><para>
	For more information about the functions used see:
	<link linkend="fn_http_xslt">http_xslt()</link>,
	<link linkend="fn_http">http()</link>,
	<link linkend="fn_http_value">http_value()</link>.
  </para>
	<para>For more information about VSP in general go the
	<link linkend="vsp1">VSP Section</link>.</para></tip>

</sect3>
</sect2>

<sect2 id="corsshare">
	  <title>Setting up server-side Cross-Origin Resource Sharing (CORS) with Virtuoso</title>
	  <para>User agents (e.g., Web browsers) have traditionally restricted scripts within web pages by a Same Origin Policy, which allowed scripts to make requests only to resources within the same domain from which the scripts themselves originated. This restriction is meant to protect the user and their computer from "Trojan horse websites" which may appear to be safe, but which then make unsafe HTTP requests to other, invisible sites. This restriction also protects the second website from potential "Denial of Service" and other attacks, whether accidental or intentional.</para>
	  <para>This policy has the unfortunate side-effect of also preventing client-side Web applications served from one website ("Origin") from retrieving data from another website ("Origin").</para>
	  <para><ulink url="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing (CORS)</ulink> is a mechanism intended to enable safer client-side cross-origin requests, primarily focused on data.</para>
	  <sect3 id="corssharewk">  
	  	 <title>How does CORS work?</title>
	  	 <para>Authentication and session-management information methods are extended in several ways:</para>
	  	 <itemizedlist mark="bullet">
	  	 	 <listitem>Enforcement by User Agent
           <itemizedlist mark="bullet">
             <listitem>A server providing a resource can include an <emphasis>Access-Control-Allow-Origin</emphasis> HTTP response header, with a value of the 
         	request's triggering script's site of origin (that is, the site which provided the script which 
         	made the request for the resource), to indicate whether access to the resource's contents may be 
         	allowed. The user agent validates that the value in this header matches the actual origin of the 
         	script which made the request.
         	   </listitem>
             <listitem>User agents can use a "pre-flight request" to discover whether a cross-origin resource 
         	is prepared to accept requests from a given script origin, using a complex method (which we will 
         	not detail here). Again, the response is validated by the user agent.
         	    </listitem>
           </itemizedlist>	  	 	 	
	  	 	 </listitem>
         <listitem>Enforcement by Server-side Application
           <itemizedlist mark="bullet">
             <listitem>Server-side applications can refer to the <emphasis>Origin</emphasis> HTTP request header 
         to discover whether the user agent deemed it a cross-origin request. Here, the server-side 
         application enforces limitations (e.g., returning nothing, partial results, or full results) on 
         the cross-origin requests that they are willing to service at all.
             </listitem>       
           </itemizedlist>	
         </listitem>	
       </itemizedlist>
	  </sect3> 
	  <sect3 id="corssharesetup">  
	  	 <title>CORS Setup for Virtuoso servers</title>
	  	 <para>With Virtuoso 6 and later (specific earliest versions as noted below), CORS support may be configured at the server-level or enabled through application logic (scripting, PL, etc.).</para>
	  	 <para>When working with older versions of Virtuoso, CORS support cannot be configured at the server-level, but it may be enabled within application logic (scripting, PL, etc.).</para>
	  	 <sect4 id="corssharesetupapplv">  
	  	   <title>Application-level CORS Setup</title>
	  	   <para>Any Virtuoso PL (VSP)-based application can implement CORS checking through well-known 
	  	   	HTTP functions <link linkend="fn_http_request_header"><function>http_request_header()</function></link> and 
	  	 	<link linkend="fn_http_header"><function>http_header()</function></link>. This method will 
	  	 	  work with any version of Virtuoso. For instance:</para>
<programlisting><![CDATA[
<?vsp 
    IF (http_request_header (lines, 'Origin', NULL) = 'http://host.org')
      {
          http_header ('Access-Control-Allow-Origin: http://host.org\r\n');
      }
   ELSE 
      {
         RETURN;
      }
-- Additional code here ---

?>
]]></programlisting>	  	 	  
         <para>Applications running in other hosted environments (Perl, Python, PHP, ASP.NET, etc.) may also use their specific scripting options to add and/or check relevent headers.</para>
	     </sect4> 	  	   
	  	 <sect4 id="corssharesetupsrvlv">  
	  	   <title>Server-level CORS Setup</title>
	  	   <para>Note: These instance/server-level configuration instructions require 
	  	   	 <ulink url="http://edit-wiki.usnet.private/dataspace/dav/wiki/VOS/VOSNews">Virtuoso Open Source (VOS) 6.1.3 or later</ulink>, 
	  	   	 or <ulink url="http://download.openlinksw.com/virtwiz/">Virtuoso Commercial Edition 6.2.3129 or later</ulink>.</para>
	  	   <orderedlist>
           <listitem>In the Virtuoso Conductor, go to <emphasis>Web Application Server -> Virtual Directories &amp; Directories</emphasis>.
             <figure id="oc1" float="1">
               <title>Server-side Cross-Origin Resource Sharing (CORS) Example Setup</title>
               <graphic fileref="ui/oc1.png"/>
             </figure>	
           </listitem>
           <listitem>Expand the <emphasis>Interface</emphasis> store. 
             <figure id="oc2" float="1">
               <title>Server-side Cross-Origin Resource Sharing (CORS) Example Setup</title>
               <graphic fileref="ui/oc2.png"/>
             </figure>	
           </listitem>
           <listitem>Click <emphasis>New Directory</emphasis>.</listitem>
           <listitem>Specify the desired <emphasis>Virtual Directory Type</emphasis>, or choose an existing virtual directory to use as a template.
             <figure id="oc3" float="1">
               <title>Server-side Cross-Origin Resource Sharing (CORS) Example Setup</title>
               <graphic fileref="ui/oc3.png"/>
             </figure>	
           </listitem>
           <listitem>Click <emphasis>Next</emphasis>.</listitem>
           <listitem>Specify the <emphasis>Directory Path</emphasis> value.
             <figure id="oc4" float="1">
               <title>Server-side Cross-Origin Resource Sharing (CORS) Example Setup</title>
               <graphic fileref="ui/oc4.png"/>
             </figure>	
           </listitem>
           <listitem>Set the <emphasis>CORS</emphasis> options.
             <figure id="oc5" float="1">
               <title>Server-side Cross-Origin Resource Sharing (CORS) Example Setup</title>
               <graphic fileref="ui/oc5.png"/>
             </figure>	
             <itemizedlist mark="bullet">
               <listitem><emphasis>Cross-Origin Resource Sharing</emphasis>: Contains a single wildcard 
                asterisk, i.e., "<emphasis>*</emphasis>", or a space-delimited list of HTTP server URIs, 
                e.g., "<emphasis>http://example.com:8080 http://blah.example.com http://foo.example.com</emphasis>". 
                Scripts originating on the listed HTTP servers are authorized to retrieve the specified 
                resource(s); the wildcard means scripts from any HTTP server will be authorized. For this 
                example, enter the following single URI:
<programlisting><![CDATA[
http://demo.openlinksw.com	
]]></programlisting>             	
               </listitem>
               <listitem><emphasis>Reject Unintended CORs</emphasis> checkbox: When ticked (and the application does not overwrite headers), unmatched Origins will be rejected by sending an empty response. For this example, tick this box.</listitem>
             </itemizedlist>
           </listitem>
           <listitem>Click Save changes.</listitem>
         </orderedlist>
       </sect4>  
	    <sect4 id="corssharewkspcurlexmp">  
	    	 <title>Example Usage with cURL</title>
	    	 <sect5 id="corssharewkspcurlexmp1">  
	    	 	 <title>Example 1</title>
           <orderedlist>
             <listitem>Suppose the example setup above is performed, and http://demo.openlinksw.com/ is in the CORS list.</listitem>
             <listitem>In this case, the request below will return an empty response:
<programlisting><![CDATA[
$ curl -i  http://demo.openlinksw.com/mytest/test.vsp
HTTP/1.1 200 OK
Server: Virtuoso/06.02.3128 (Win32) i686-generic-win-32  VDB
Connection: Keep-Alive
Content-Type: text/html; charset=ISO-8859-1
Date: Thu, 28 Oct 2010 09:27:54 GMT
Accept-Ranges: bytes
Content-Length: 0
]]></programlisting>           	
            </listitem>
          </orderedlist>	  	 	
	      </sect5> 	  	 	
	  	  <sect5 id="corssharewkspcurlexmp2">  
	  	  	<title>Example 2</title>
          <orderedlist>
            <listitem>Suppose the example Setup above is performed, and http://demo.openlinksw.com/ is in the CORS list.</listitem>
            <listitem>Also, suppose the curl command includes a proper Origin value, e.g.:
<programlisting><![CDATA[
-H "Origin: http://demo.openlinksw.com"
]]></programlisting>
           </listitem>
           <listitem>In this case, the request below will return a response including the retrieved content, etc.
<programlisting><![CDATA[
$ curl -i -H "Origin: http://demo.openlinksw.com"  http://demo.openlinksw.com/mytest/test.vsp
HTTP/1.1 200 OK
Server: Virtuoso/06.02.3128 (Win32) i686-generic-win-32  VDB
Connection: Keep-Alive
Content-Type: text/html; charset=ISO-8859-1
Date: Thu, 28 Oct 2010 09:40:21 GMT
Access-Control-Allow-Origin: http://demo.openlinksw.com
Accept-Ranges: bytes
Content-Length: 7
]]></programlisting>           	
           </listitem>
         </orderedlist>	  	 	
	     </sect5> 	  	 	
	  	 <sect5 id="corssharewkspcurlexmp3">  
	  	 	 <title>Example 3</title>
         <orderedlist>
           <listitem>Suppose the Example Setup above is performed, but reject is off (i.e., "Reject Unintended CORs" check-box is not ticked).</listitem>
           <listitem>In this case, the request below will return a response that lacks Access-Control-Allow-Origin:
<programlisting><![CDATA[
$ curl -i  http://demo.openlinksw.com/mytest/test.vsp
HTTP/1.1 200 OK
Server: Virtuoso/06.02.3128 (Win32) i686-generic-win-32  VDB
Connection: Keep-Alive
Content-Type: text/html; charset=ISO-8859-1
Date: Thu, 28 Oct 2010 09:45:01 GMT
Accept-Ranges: bytes
Content-Length: 7
]]></programlisting>           	
           </listitem>
         </orderedlist>	  	 	
	     </sect5> 	  
	   </sect4>	 	
	  </sect3> 
	  <tip><title>See Also:</title>
      <para><ulink url="https://wiki.mozilla.org/Security/Origin">Origin header proposal for CSRF and click-jacking mitigation</ulink></para>
      <para><ulink url="http://arunranga.com/examples/access-control/">CORS In Action</ulink></para>
      <para><ulink url="http://www.nczonline.net/blog/2010/05/25/cross-domain-ajax-with-cross-origin-resource-sharing/">Cross-domain Ajax with Cross-Origin Resource Sharing</ulink></para>
      <para><ulink url="http://code.google.com/p/html5security/wiki/CrossOriginRequestSecurity">Guide to Secure Implementation of Cross Origin Requests in HTML5</ulink></para>
    </tip>
  </sect2>		
</sect1>