New file open operators

Author: bengsig

CHANGELOG.md

@@ -9,6 +9,8 @@
 * oltp: Save and report buffer cache/shared pool size
 * oltp: Output details about aw\_cols size and access
 * oltp: Option to emulate batch with no wait time
+* New more secure syntax for file/pipe open
+* Public utility netthroughput.rwl replaces nettest.rwl
 
 ## 3.0.2
 

admin/.vim/syntax/rwl.vim

@@ -102,6 +102,9 @@ syn match rwlDirective '\$nameexpand:on'
 syn match rwlDirective '\$nameexpand:off'
 syn match rwlDirective '\$reconnect1017:on'
 syn match rwlDirective '\$reconnect1017:off'
+syn match rwlDirective '\$pre31fileassign:warn'
+syn match rwlDirective '\$pre31fileassign:on'
+syn match rwlDirective '\$pre31fileassign:off'
 syn match rwlDirective '\$queue:on'
 syn match rwlDirective '\$queue:off'
 syn match rwlDirective '\$setaction:on'

docs/ERRORLIST.md

@@ -1147,6 +1147,21 @@ are recommended making sure no sensitive information is included in the
 generated executable. Note that rwloadsim cannot complete verify no sensitive
 inforation is put in the executable.
 
+### RWL-291 warning: "opening a file with '%s' in the file name is deprecated"
+In version 3.1, you need to change your syntax for opening files to use
+either of these assignment operators: >=, >>=, <=, |=, =| in stead of using
+similar characters as part of the text string assigned to the file variable.
+
+### RWL-292 error: "opening a file with '%s' in the file name is no longer supported"
+In version 3.1, you need to change your syntax for opening files to use
+either of these assignment operators: >=, >>=, <=, |=, =| in stead of using
+similar characters as part of the text string assigned to the file variable.
+To allow the previous behavior, use $pre31fileassign:on directive.
+
+### RWL-293 warning: "closing a file with an operator used for open"
+You are using one of the operators used to open a file or pipeline to
+close a file by assigning null to it. You should use the := operator.
+
 ### RWL-600 internal error: '%s'
 An abnormal situation caused an internal error in rwloadsim.
 This is in most cases due to a programming error and it

docs/FILE.md

@@ -3,31 +3,30 @@ Variables of type file are grossly comparable to FILE * variables in C
 and most operations on files in rwloadsim are implemented using 
 standard calls like fopen(), popen(), fgets(), fprintf() etc.
 All files are line oriented.
-You open a file by assigning a string to it, and close a file by 
+You open a file for writing by assigning a string to it, and close a file by 
 assigning null to it.
 Depending on how it was opened, you can use operations like readline 
 and writeline.  
 
-The string that is assigned to the file is interpreted similar to how the shell does it,
-and the file can be opened in one of these five ways:
+There are different assignment operators to allow for read, append, etc:
 
-* To open for write, simply assign a string containing the file name to it; for completeness with the other options, a single initial ">" can be used.
-* To open for append, the first two characters of the string must be "\>\>"
-* To open for read, the first character of the string must be "<"
-* To open a pipeline for write, the first character of the string must be "\|" and the following characters will be the actual pipeline.
-* To open a pipeline for read, the last character of the string must be "\|".
+* To open for write, simply assign a string containing the file name to it using := or >=.
+* To open for append, use the >>= assignment operator.
+* To open for read, use the <= assignment operator.
+* To open a pipeline for write, use the \|= operator, the concatenation will be the command to execute.
+* To open a pipeline for read, use the =\| operator, the concatenation will be the command to execute.
 
-In all cases, the initial or terminating character(s) are removed and will not be part of the file or pipe-line.
-
-Rwloadsim does not include advanced output formatting, strings are 
+The writeline and printline commands of rwloadsim do not include
+advanced output formatting, strings are 
 output as is and integers or doubles are output using a predefined 
 printf format of %d and %.2f respectively; these can be changed at 
 compile time using directives.
+To get output formatting, use fprintf.
 
 This simple example
 ```
 file hello;
-hello := "hello.txt";
+hello >= "hello.txt";
 writeline hello, "Hello, World";
 hello := null;
 ```
@@ -38,7 +37,7 @@ A simple example of reading from a pipeline is:
 file id;
 string(1000) myid;
 
-id := "id|";
+id =| "id";
 readline id,myid;
 id := null;
 
@@ -70,8 +69,8 @@ double a, b;
 
 file yt;
 
-# The initial > is optional here as the default is to open for writing
-yt:=">numbers.txt";
+# You could also use the := operator
+yt >= "numbers.txt";
 
 # write number from 1 until 10 and their 
 # squares to the file numbers.txt
@@ -82,7 +81,7 @@ end loop;
 yt := null; # close the file
 
 # use a pipeline to read the file
-yt := "cat numbers.txt|";
+yt =| "cat numbers.txt";
 
 for readline yt,a,b loop # similar to read a,b in the shell
   printline a,b,sqrt(b);

docs/NEWS30.md

@@ -1,3 +1,16 @@
+## Changed behavior in version 3.0.3 of the RWP\*Load Simulator
+
+The syntax for opening files and pipelines has been enhanced with
+new operators: >=, >>=, <=, |= and =|. 
+These replace the previous behavior where the contents of the 
+concatenation being assigned to a file would be interpreted to
+imply open for read, append, or as a pipeline respectively.
+This has a security concern and is deprecated, it will
+be desupported in an upcoming 3.1 release.
+You can enable warnings when using the current approach via
+the $pre31fileassign:warn directive, and it is suggested
+you put this directive in your .rwloadsim.rwl startup file.
+
 ## Changed behavior in version 3.0.1 of the RWP\*Load Simulator
 
 ### Keywords initiating SQL

docs/refman/directive.html

@@ -349,6 +349,25 @@ Be default, the flag OCI_SPC_NO_RLB is set, to not set this flag, use the second
 directive before the database using a session pool is declared.
 .RE
 .P
+.B $pre31fileassign:on
+.br
+.B $pre31fileassign:warn
+.br
+.B $pre31fileassign:off
+.RS 4
+These directives control how file assignment using the \fB:=\fR operator behave.
+When the directive is set to \fBon\fR, you can use re-direction characters
+such as "<", ">>", "|" as part of the name of the file causing the file to
+be opened for read, append or as a pipeline.
+When set to \fBwarn\fR, you will get a runtime warning about such use,
+and if set to \fBoff\fR, you will get a runtime error.
+In the current release (3.0.3), the default is \fBoff\fR; it will be set
+to \fBon\fR in release 3.1.
+.P
+It is recommended that you run your rwloadsim with \fBwarn\fR and use the
+generated warnings to modify your code to use the newer file assignment operators.
+.RE
+.P
 .B $useroption:name
 .br
 .B $userswitch:name
@@ -369,4 +388,4 @@ Licensed under the Universal Permissive License v 1.0
 as shown at https://oss.oracle.com/licenses/upl
 .SH "SEE ALSO"
 rwloadsim(1rwl), useroption(1rwl), longoption(1rwl), include(1rwl),
-conditional(1rwl), sqldeclaration(1rwl), printfstatement(1rwl)
+conditional(1rwl), sqldeclaration(1rwl), printfstatement(1rwl), filestatement(1rwl)