package require opt 0.2;
namespace eval ::safe {
namespace export interpCreate interpInit interpConfigure interpDelete \
interpAddToAccessPath interpFindInAccessPath \
setLogCmd ;
set temp [::tcl::OptKeyRegister {
{-accessPath -list {} "access path for the slave"}
{-noStatics "prevent loading of statically linked pkgs"}
{-statics true "loading of statically linked pkgs"}
{-nestedLoadOk "allow nested loading"}
{-nested false "nested loading"}
{-deleteHook -script {} "delete hook"}
}]
::tcl::OptKeyRegister {
{?slave? -name {} "name of the slave (optional)"}
} ::safe::interpCreate ;
lappend ::tcl::OptDesc(::safe::interpCreate) $::tcl::OptDesc($temp);
::tcl::OptKeyRegister {
{slave -name {} "name of the slave"}
} ::safe::interpIC;
lappend ::tcl::OptDesc(::safe::interpIC) $::tcl::OptDesc($temp);
::tcl::OptKeyDelete $temp;
proc InterpStatics {} {
foreach v {Args statics noStatics} {
upvar $v $v
}
set flag [::tcl::OptProcArgGiven -noStatics];
if {$flag && ($noStatics == $statics)
&& ([::tcl::OptProcArgGiven -statics])} {
return -code error\
"conflicting values given for -statics and -noStatics";
}
if {$flag} {
return [expr {!$noStatics}];
} else {
return $statics
}
}
proc InterpNested {} {
foreach v {Args nested nestedLoadOk} {
upvar $v $v
}
set flag [::tcl::OptProcArgGiven -nestedLoadOk];
if {$flag && ($nestedLoadOk != $nested)
&& ([::tcl::OptProcArgGiven -nested])} {
return -code error\
"conflicting values given for -nested and -nestedLoadOk";
}
if {$flag} {
return $nestedLoadOk
} else {
return $nested
}
}
proc interpCreate {args} {
set Args [::tcl::OptKeyParse ::safe::interpCreate $args]
InterpCreate $slave $accessPath \
[InterpStatics] [InterpNested] $deleteHook;
}
proc interpInit {args} {
set Args [::tcl::OptKeyParse ::safe::interpIC $args]
if {![::interp exists $slave]} {
return -code error \
"\"$slave\" is not an interpreter";
}
InterpInit $slave $accessPath \
[InterpStatics] [InterpNested] $deleteHook;
}
proc CheckInterp {slave} {
if {![IsInterp $slave]} {
return -code error \
"\"$slave\" is not an interpreter managed by ::safe::" ;
}
}
proc interpConfigure {args} {
switch [llength $args] {
1 {
set Args [::tcl::OptKeyParse ::safe::interpIC $args];
CheckInterp $slave;
set res {}
lappend res [list -accessPath [Set [PathListName $slave]]]
lappend res [list -statics [Set [StaticsOkName $slave]]]
lappend res [list -nested [Set [NestedOkName $slave]]]
lappend res [list -deleteHook [Set [DeleteHookName $slave]]]
join $res
}
2 {
::tcl::Lassign $args slave arg;
set desc [lindex [::tcl::OptKeyGetDesc ::safe::interpIC] 2]
set hits [::tcl::OptHits desc $arg];
if {$hits > 1} {
return -code error [::tcl::OptAmbigous $desc $arg]
} elseif {$hits == 0} {
return -code error [::tcl::OptFlagUsage $desc $arg]
}
CheckInterp $slave;
set item [::tcl::OptCurDesc $desc];
set name [::tcl::OptName $item];
switch -exact -- $name {
-accessPath {
return [list -accessPath [Set [PathListName $slave]]]
}
-statics {
return [list -statics [Set [StaticsOkName $slave]]]
}
-nested {
return [list -nested [Set [NestedOkName $slave]]]
}
-deleteHook {
return [list -deleteHook [Set [DeleteHookName $slave]]]
}
-noStatics {
return -code error\
"ambigous query (get or set -noStatics ?)\
use -statics instead";
}
-nestedLoadOk {
return -code error\
"ambigous query (get or set -nestedLoadOk ?)\
use -nested instead";
}
default {
return -code error "unknown flag $name (bug)";
}
}
}
default {
set Args [::tcl::OptKeyParse ::safe::interpIC $args];
CheckInterp $slave;
if {![::tcl::OptProcArgGiven -accessPath]} {
set doreset 1
set accessPath [Set [PathListName $slave]]
} else {
set doreset 0
}
if { (![::tcl::OptProcArgGiven -statics])
&& (![::tcl::OptProcArgGiven -noStatics]) } {
set statics [Set [StaticsOkName $slave]]
} else {
set statics [InterpStatics]
}
if { ([::tcl::OptProcArgGiven -nested])
|| ([::tcl::OptProcArgGiven -nestedLoadOk]) } {
set nested [InterpNested]
} else {
set nested [Set [NestedOkName $slave]]
}
if {![::tcl::OptProcArgGiven -deleteHook]} {
set deleteHook [Set [DeleteHookName $slave]]
}
InterpSetConfig $slave $accessPath \
$statics $nested $deleteHook;
if {$doreset} {
if {[catch {::interp eval $slave {auto_reset}} msg]} {
Log $slave "auto_reset failed: $msg";
} else {
Log $slave "successful auto_reset" NOTICE;
}
}
}
}
}
proc ::safe::InterpCreate {
slave
access_path
staticsok
nestedok
deletehook
} {
if {[string compare "" $slave]} {
::interp create -safe $slave;
} else {
set slave [::interp create -safe];
}
Log $slave "Created" NOTICE;
InterpInit $slave $access_path $staticsok $nestedok $deletehook;
}
proc ::safe::InterpSetConfig {slave access_path staticsok\
nestedok deletehook} {
if {[string match "" $access_path]} {
set access_path [uplevel set where [lsearch -exact $access_path [info library]];
if {$where == -1} {
set access_path [concat [list [info library]] $access_path];
Log $slave "tcl_library was not in auto_path,\
added it to slave's access_path" NOTICE;
} elseif {$where != 0} {
set access_path [concat [list [info library]]\
[lreplace $access_path $where $where]];
Log $slave "tcl_libray was not in first in auto_path,\
moved it to front of slave's access_path" NOTICE;
}
set access_path [AddSubDirs $access_path];
}
Log $slave "Setting accessPath=($access_path) staticsok=$staticsok\
nestedok=$nestedok deletehook=($deletehook)" NOTICE;
set nname [PathNumberName $slave];
if {[Exists $nname]} {
set n [Set $nname];
for {set i 0} {$i<$n} {incr i} {
Unset [PathToken $i $slave];
}
}
set slave_auto_path {}
set i 0;
foreach dir $access_path {
Set [PathToken $i $slave] $dir;
lappend slave_auto_path "\$[PathToken $i]";
incr i;
}
Set $nname $i;
Set [PathListName $slave] $access_path;
Set [VirtualPathListName $slave] $slave_auto_path;
Set [StaticsOkName $slave] $staticsok
Set [NestedOkName $slave] $nestedok
Set [DeleteHookName $slave] $deletehook
SyncAccessPath $slave;
}
proc ::safe::interpFindInAccessPath {slave path} {
set access_path [GetAccessPath $slave];
set where [lsearch -exact $access_path $path];
if {$where == -1} {
return -code error "$path not found in access path $access_path";
}
return "\$[PathToken $where]";
}
proc ::safe::interpAddToAccessPath {slave path} {
if {![catch {interpFindInAccessPath $slave $path} res]} {
return $res;
}
set nname [PathNumberName $slave];
set n [Set $nname];
Set [PathToken $n $slave] $path;
set token "\$[PathToken $n]";
Lappend [VirtualPathListName $slave] $token;
Lappend [PathListName $slave] $path;
Set $nname [expr {$n+1}];
SyncAccessPath $slave;
return $token;
}
proc ::safe::InterpInit {
slave
access_path
staticsok
nestedok
deletehook
} {
InterpSetConfig $slave $access_path $staticsok $nestedok $deletehook;
::interp alias $slave source {} [namespace current]::AliasSource $slave
::interp alias $slave load {} [namespace current]::AliasLoad $slave
AliasSubset $slave file file dir.* join root.* ext.* tail \
path.* split
::interp alias $slave exit {} [namespace current]::interpDelete $slave
if {[catch {::interp eval $slave\
{source [file join $tcl_library init.tcl]}}\
msg]} {
Log $slave "can't source init.tcl ($msg)";
error "can't source init.tcl into slave $slave ($msg)"
}
return $slave
}
proc AddSubDirs {pathList} {
set res {}
foreach dir $pathList {
if {[file isdirectory $dir]} {
if {[lsearch -exact $res $dir]<0} {
lappend res $dir;
}
foreach sub [glob -nocomplain -- [file join $dir *]] {
if { ([file isdirectory $sub])
&& ([lsearch -exact $res $sub]<0) } {
lappend res $sub;
}
}
}
}
return $res;
}
proc ::safe::interpDelete {slave} {
Log $slave "About to delete" NOTICE;
set hookname [DeleteHookName $slave];
if {[Exists $hookname]} {
set hook [Set $hookname];
if {![::tcl::Lempty $hook]} {
Unset $hookname;
if {[catch {eval $hook [list $slave]} err]} {
Log $slave "Delete hook error ($err)";
}
}
}
set statename [InterpStateName $slave];
if {[Exists $statename]} {
Unset $statename;
}
if {[::interp exists $slave]} {
::interp delete $slave;
Log $slave "Deleted" NOTICE;
}
return
}
proc ::safe::setLogCmd {args} {
variable Log;
if {[llength $args] == 0} {
return $Log;
} else {
if {[llength $args] == 1} {
set Log [lindex $args 0];
} else {
set Log $args
}
}
}
variable Log {}
proc SyncAccessPath {slave} {
set slave_auto_path [Set [VirtualPathListName $slave]];
::interp eval $slave [list set auto_path $slave_auto_path];
Log $slave \
"auto_path in $slave has been set to $slave_auto_path"\
NOTICE;
::interp eval $slave [list set tcl_library [lindex $slave_auto_path 0]];
}
proc InterpStateName {slave} {
return "S$slave";
}
proc IsInterp {slave} {
expr { ([Exists [InterpStateName $slave]])
&& ([::interp exists $slave])}
}
proc PathToken {n {slave ""}} {
if {[string compare "" $slave]} {
return "[InterpStateName $slave](access_path,$n)";
} else {
return "p(:$n:)";
}
}
proc PathListName {slave} {
return "[InterpStateName $slave](access_path)";
}
proc VirtualPathListName {slave} {
return "[InterpStateName $slave](access_path_slave)";
}
proc PathNumberName {slave} {
return "[InterpStateName $slave](access_path,n)";
}
proc StaticsOkName {slave} {
return "[InterpStateName $slave](staticsok)";
}
proc NestedOkName {slave} {
return "[InterpStateName $slave](nestedok)";
}
proc Toplevel {args} {
namespace eval [namespace current] $args;
}
proc Set {args} {
eval Toplevel set $args;
}
proc Lappend {args} {
eval Toplevel lappend $args;
}
proc Unset {args} {
eval Toplevel unset $args;
}
proc Exists {varname} {
Toplevel info exists $varname;
}
proc GetAccessPath {slave} {
Set [PathListName $slave]
}
proc StaticsOk {slave} {
Set [StaticsOkName $slave]
}
proc NestedOk {slave} {
Set [NestedOkName $slave]
}
proc DeleteHookName {slave} {
return [InterpStateName $slave](cleanupHook)
}
proc TranslatePath {slave path} {
if {[regexp {(::)|(\.\.)} $path]} {
error "invalid characters in path $path";
}
set n [expr {[Set [PathNumberName $slave]]-1}];
for {} {$n>=0} {incr n -1} {
set [PathToken $n] [Set [PathToken $n $slave]];
}
subst -nobackslashes -nocommands $path;
}
proc Log {slave msg {type ERROR}} {
variable Log;
if {[info exists Log] && [llength $Log]} {
eval $Log [list "$type for slave $slave : $msg"];
}
}
proc CheckFileName {slave file} {
set ftail [file tail $file];
if {[string length $ftail]>14} {
error "$ftail: filename too long";
}
if {[regexp {\..*\.} $ftail]} {
error "$ftail: more than one dot is forbidden";
}
if {[string compare $ftail "tclIndex"] && \
[string compare [string tolower [file extension $ftail]]\
".tcl"]} {
error "$ftail: must be a *.tcl or tclIndex";
}
if {![file exists $file]} {
error "no such file or directory";
}
if {![file readable $file]} {
error "not readable";
}
}
proc AliasSource {slave args} {
set argc [llength $args];
if {$argc != 1} {
set msg "wrong # args: should be \"source fileName\""
Log $slave "$msg ($args)";
return -code error $msg;
}
set file [lindex $args 0]
if {[catch {set file [TranslatePath $slave $file]} msg]} {
Log $slave $msg;
return -code error "permission denied"
}
if {[catch {FileInAccessPath $slave $file} msg]} {
Log $slave $msg;
return -code error "permission denied"
}
if {[catch {CheckFileName $slave $file} msg]} {
Log $slave "$file:$msg";
return -code error $msg;
}
if {[catch {::interp invokehidden $slave source $file} msg]} {
Log $slave $msg;
return -code error "script error";
}
return $msg
}
proc AliasLoad {slave file args} {
set argc [llength $args];
if {$argc > 2} {
set msg "load error: too many arguments";
Log $slave "$msg ($argc) {$file $args}";
return -code error $msg;
}
set package [lindex $args 0];
set target [lindex $args 1];
if {[string length $target]} {
if {![NestedOk $slave]} {
Log $slave "loading to a sub interp (nestedok)\
disabled (trying to load $package to $target)";
return -code error "permission denied (nested load)";
}
}
if {[string length $file] == 0} {
if {[string length $package] == 0} {
set msg "load error: empty filename and no package name";
Log $slave $msg;
return -code error $msg;
}
if {![StaticsOk $slave]} {
Log $slave "static packages loading disabled\
(trying to load $package to $target)";
return -code error "permission denied (static package)";
}
} else {
if {[catch {set file [TranslatePath $slave $file]} msg]} {
Log $slave $msg;
return -code error "permission denied"
}
if {[catch {FileInAccessPath $slave $file} msg]} {
Log $slave $msg;
return -code error "permission denied (path)"
}
}
if {[catch {::interp invokehidden\
$slave load $file $package $target} msg]} {
Log $slave $msg;
return -code error $msg
}
return $msg
}
proc FileInAccessPath {slave file} {
set access_path [GetAccessPath $slave];
if {[file isdirectory $file]} {
error "\"$file\": is a directory"
}
set parent [file dirname $file]
if {[lsearch -exact $access_path $parent] == -1} {
error "\"$file\": not in access_path";
}
}
proc Subset {slave command okpat args} {
set subcommand [lindex $args 0]
if {[regexp $okpat $subcommand]} {
return [eval {$command $subcommand} [lrange $args 1 end]]
}
set msg "not allowed to invoke subcommand $subcommand of $command";
Log $slave $msg;
error $msg;
}
proc AliasSubset {slave alias target args} {
set pat ^(; set sep ""
foreach sub $args {
append pat $sep$sub
set sep |
}
append pat )\$
::interp alias $slave $alias {}\
[namespace current]::Subset $slave $target $pat
}
}