Re: [Opensim-dev] Adding an assembly reference to make available via script
J Lothian wrote:
I'm not so sure that the current setup includes the System namespace.
The only assembly, other than the OpenSim specific ones, that is loaded
is System.Collections.Generic. I had to add System before I could even
use Exceptions, which seems to indicate that only parts of System that
are pulled in are the parts used by the other assemblies that are loaded.
Actually, one can still use other classes just fine if they are referenced by
their full names. For example, my script
//c#
// justincc's short test script
string message = Hello avatar!;
string xml = tagribbit/tag;
public void default_event_state_entry()
{
llSay(0, message);
}
public void default_event_touch_start(
LSL_Types.LSLInteger total_number)
{
System.IO.StringReader sr
= new System.IO.StringReader(xml);
System.Xml.XmlTextReader reader
= new System.Xml.XmlTextReader(sr);
llSay(0, reader.ReadElementString(tag));
}
works just fine on OpenSim Git master with no alterations other than allowing
cs scripts.
Melanie's response (which I mostly agree with) is why I didn't post it
on the Wiki. This isn't something the average user (specifically
OpenGrid users) should probably be doing. But rather than saying
absolutely not, I have to wonder if there's some reasonable middle
ground that can do the job of both 1) protecting the average
installation from arbitrary library code inclusion/execution, and 2)
allowing an easier way to include that facility, for users that -do-
need it, as a way for others to make OpenSim more flexible.
To be honest, I don't think the average user looks on the development section
of the wiki anyway :). Also, none of this stuff is available unless the region
operator specifically allows c# scripts. I would really like to see this
documentation over there along with security warnings about using c# scripts at
all.
But the real solution could be to properly sandbox scripts. I know that there
was some discussion about this a long time ago and there's some good technical
reason why it's not possible yet, but I can't remember what that is.
Compile-time isn't a show-stopper, but something that makes the process
easier, like a module, or something in the build system/environment like
an scriptengine_additional_libraries variable might be handy.
Basically, narrowing down a potential point of failure to one place,
instead of three.
Thanks again though, my team here really appreciates all the hard work
you all put into this.
Many thanks Jeremy, I'm sure from all of us.
Be very interested to know what your team are using OpenSim for, though I
appreciate that might not be possible if the work isn't in the open.
Best,
Justin.
--Jeremy Lothian
On Thu, May 27, 2010 at 8:11 PM, Justin Clark-Casey
jjusti...@googlemail.com mailto:jjusti...@googlemail.com wrote:
Melanie wrote:
A generic means to add extra libs would be highly DANGEROUS. It
definitely needs to be compile-time. Probably has to be, anyway,
from the way the scripts work.
C# scripts are insecure anyway since anybody who can create them has
access to the System namespaces. They are still useful in contexts
where script creation and editing are restricted or all parties are
highly trusted.
Melanie
Justin Clark-Casey wrote:
J Lothian wrote:
Justin,
Thanks for pointing me in a direction, this was -very-
helpful. It wasn't nearly as straightforward as I was
expecting, but it did give me the opportunity/excuse to
get my hands dirty and dig into the projects and code a
bit. I'm going to document the process a bit here, so
it gets archived for future reference. I'm pretty sure
I've narrowed down the steps needed.
The actual project that needs the assembly reference
added to it is
OpenSim.Region.ScriptEngine.Shared.CodeTools, but this
is just the start. This gets the assembly detectable by
the compiler. The next step is adding the reference to
the script being compiled. In
OpenSim.Region.ScriptEngine.Shared.CodeTools.Compiler
(Compiler.cs), in the function CompileFromDotNetText,
there is a section where ReferencedAssemblies are added
to the compiler as parameters, and the assembly needs to
be added here as well. For example, to add a standard
library, the following line would be used:
parameters.ReferencedAssemblies.Add(System.dll);
Which, it turns out, I needed to do, as System.dll
isn't added by default, and our test script included a
try/catch where Exception was not detected as a type.
To add
Re: [Opensim-dev] Adding an assembly reference to make available via script
Justin, Thanks for pointing me in a direction, this was -very- helpful. It wasn't nearly as straightforward as I was expecting, but it did give me the opportunity/excuse to get my hands dirty and dig into the projects and code a bit. I'm going to document the process a bit here, so it gets archived for future reference. I'm pretty sure I've narrowed down the steps needed. The actual project that needs the assembly reference added to it is OpenSim.Region.ScriptEngine.Shared.CodeTools, but this is just the start. This gets the assembly detectable by the compiler. The next step is adding the reference to the script being compiled. In OpenSim.Region.ScriptEngine.Shared.CodeTools.Compiler (Compiler.cs), in the function CompileFromDotNetText, there is a section where ReferencedAssemblies are added to the compiler as parameters, and the assembly needs to be added here as well. For example, to add a standard library, the following line would be used: parameters.ReferencedAssemblies.Add(System.dll); Which, it turns out, I needed to do, as System.dll isn't added by default, and our test script included a try/catch where Exception was not detected as a type. To add something like the MySql dll that comes with OpenSim, it would look like this: parameters.ReferencedAssemblies.Add(Path.Combine(rootPath,MySql.Data.dll )); The script engine automatically wraps scripts in boilerplate code to put them inside a class and make them compilable. This has the side-effect of making using or import statements inside scripts impossible, so these also need to be added to the code. For example, if your script is C#, then the function to alter is CreateCSCompilerScript (in the same Compile.cs), adding the using statement to the list inside this function. If I get the chance later this summer, I may try to develop a more robust system that attempts to (at the very least) detect the default mono/.net libraries and automatically adjust this boilerplate to include them... Again, thanks for the help! --Jeremy Lothian On Fri, May 14, 2010 at 9:19 PM, Justin Clark-Casey jjusti...@googlemail.com wrote: J Lothian wrote: Greetings, I'm a developer working on a research project that we are migrating from Second Life to OpenSim. We're currently exploring options and new features that may be available in OpenSim that we did not have in Second Life. One of these items is the ability to add a custom assembly reference to be available for scripts within the scripting engine (in C# mode). I am very unfamiliar with the mono/nant build process. I searched for this question a bit and couldn't find anything very related. Could someone point me towards which files I should be looking at to add an assembly reference? Is this even possible? Also, apologies if this is the wrong list, I wasn't sure if this was a user or developer question. If you want to directly call your own C# assembly from within C# scripts, then I believe that you would have to explicitly add those assemblies to prebuild.xml before regenerating the solution files with prebuild.sh/prebuild.bat. The project you would need to add to is OpenSim.Region.ScriptEngine.Shared.Api, I think. However, some of this is supposition - I've never tried this before. I don't think there is any documentation on it. -- Justin Clark-Casey (justincc) http://justincc.org http://twitter.com/justincc ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev
Re: [Opensim-dev] Adding an assembly reference to make available via script
J Lothian wrote: Justin, Thanks for pointing me in a direction, this was -very- helpful. It wasn't nearly as straightforward as I was expecting, but it did give me the opportunity/excuse to get my hands dirty and dig into the projects and code a bit. I'm going to document the process a bit here, so it gets archived for future reference. I'm pretty sure I've narrowed down the steps needed. The actual project that needs the assembly reference added to it is OpenSim.Region.ScriptEngine.Shared.CodeTools, but this is just the start. This gets the assembly detectable by the compiler. The next step is adding the reference to the script being compiled. In OpenSim.Region.ScriptEngine.Shared.CodeTools.Compiler (Compiler.cs), in the function CompileFromDotNetText, there is a section where ReferencedAssemblies are added to the compiler as parameters, and the assembly needs to be added here as well. For example, to add a standard library, the following line would be used: parameters.ReferencedAssemblies.Add(System.dll); Which, it turns out, I needed to do, as System.dll isn't added by default, and our test script included a try/catch where Exception was not detected as a type. To add something like the MySql dll that comes with OpenSim, it would look like this: parameters.ReferencedAssemblies.Add( Path.Combine(rootPath,MySql.Data.dll));The script engine automatically wraps scripts in boilerplate code to put them inside a class and make them compilable. This has the side-effect of making using or import statements inside scripts impossible, so these also need to be added to the code. For example, if your script is C#, then the function to alter is CreateCSCompilerScript (in the same Compile.cs), adding the using statement to the list inside this function. If I get the chance later this summer, I may try to develop a more robust system that attempts to (at the very least) detect the default mono/.net libraries and automatically adjust this boilerplate to include them... Again, thanks for the help! Glad that was of some use! Would very much look forward to a boilerplate adjuster - being able to include extra libraries from OpenSim C# 'scripts' would be really useful. Also, it would be great if you could copy the above into a new wiki page off http://opensimulator.org/wiki/Developer_Documentation#Scripting. Things tend to stay a little bit more visible there. Thanks! -- Justin Clark-Casey (justincc) http://justincc.org http://twitter.com/justincc ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev
Re: [Opensim-dev] Adding an assembly reference to make available via script
A generic means to add extra libs would be highly DANGEROUS. It definitely needs to be compile-time. Probably has to be, anyway, from the way the scripts work. Melanie Justin Clark-Casey wrote: J Lothian wrote: Justin, Thanks for pointing me in a direction, this was -very- helpful. It wasn't nearly as straightforward as I was expecting, but it did give me the opportunity/excuse to get my hands dirty and dig into the projects and code a bit. I'm going to document the process a bit here, so it gets archived for future reference. I'm pretty sure I've narrowed down the steps needed. The actual project that needs the assembly reference added to it is OpenSim.Region.ScriptEngine.Shared.CodeTools, but this is just the start. This gets the assembly detectable by the compiler. The next step is adding the reference to the script being compiled. In OpenSim.Region.ScriptEngine.Shared.CodeTools.Compiler (Compiler.cs), in the function CompileFromDotNetText, there is a section where ReferencedAssemblies are added to the compiler as parameters, and the assembly needs to be added here as well. For example, to add a standard library, the following line would be used: parameters.ReferencedAssemblies.Add(System.dll); Which, it turns out, I needed to do, as System.dll isn't added by default, and our test script included a try/catch where Exception was not detected as a type. To add something like the MySql dll that comes with OpenSim, it would look like this: parameters.ReferencedAssemblies.Add( Path.Combine(rootPath,MySql.Data.dll));The script engine automatically wraps scripts in boilerplate code to put them inside a class and make them compilable. This has the side-effect of making using or import statements inside scripts impossible, so these also need to be added to the code. For example, if your script is C#, then the function to alter is CreateCSCompilerScript (in the same Compile.cs), adding the using statement to the list inside this function. If I get the chance later this summer, I may try to develop a more robust system that attempts to (at the very least) detect the default mono/.net libraries and automatically adjust this boilerplate to include them... Again, thanks for the help! Glad that was of some use! Would very much look forward to a boilerplate adjuster - being able to include extra libraries from OpenSim C# 'scripts' would be really useful. Also, it would be great if you could copy the above into a new wiki page off http://opensimulator.org/wiki/Developer_Documentation#Scripting. Things tend to stay a little bit more visible there. Thanks! ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev
Re: [Opensim-dev] Adding an assembly reference to make available via script
Melanie wrote: A generic means to add extra libs would be highly DANGEROUS. It definitely needs to be compile-time. Probably has to be, anyway, from the way the scripts work. C# scripts are insecure anyway since anybody who can create them has access to the System namespaces. They are still useful in contexts where script creation and editing are restricted or all parties are highly trusted. Melanie Justin Clark-Casey wrote: J Lothian wrote: Justin, Thanks for pointing me in a direction, this was -very- helpful. It wasn't nearly as straightforward as I was expecting, but it did give me the opportunity/excuse to get my hands dirty and dig into the projects and code a bit. I'm going to document the process a bit here, so it gets archived for future reference. I'm pretty sure I've narrowed down the steps needed. The actual project that needs the assembly reference added to it is OpenSim.Region.ScriptEngine.Shared.CodeTools, but this is just the start. This gets the assembly detectable by the compiler. The next step is adding the reference to the script being compiled. In OpenSim.Region.ScriptEngine.Shared.CodeTools.Compiler (Compiler.cs), in the function CompileFromDotNetText, there is a section where ReferencedAssemblies are added to the compiler as parameters, and the assembly needs to be added here as well. For example, to add a standard library, the following line would be used: parameters.ReferencedAssemblies.Add(System.dll); Which, it turns out, I needed to do, as System.dll isn't added by default, and our test script included a try/catch where Exception was not detected as a type. To add something like the MySql dll that comes with OpenSim, it would look like this: parameters.ReferencedAssemblies.Add( Path.Combine(rootPath,MySql.Data.dll));The script engine automatically wraps scripts in boilerplate code to put them inside a class and make them compilable. This has the side-effect of making using or import statements inside scripts impossible, so these also need to be added to the code. For example, if your script is C#, then the function to alter is CreateCSCompilerScript (in the same Compile.cs), adding the using statement to the list inside this function. If I get the chance later this summer, I may try to develop a more robust system that attempts to (at the very least) detect the default mono/.net libraries and automatically adjust this boilerplate to include them... Again, thanks for the help! Glad that was of some use! Would very much look forward to a boilerplate adjuster - being able to include extra libraries from OpenSim C# 'scripts' would be really useful. Also, it would be great if you could copy the above into a new wiki page off http://opensimulator.org/wiki/Developer_Documentation#Scripting. Things tend to stay a little bit more visible there. Thanks! ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev -- Justin Clark-Casey (justincc) http://justincc.org http://twitter.com/justincc ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev
Re: [Opensim-dev] Adding an assembly reference to make available via script
I'm not so sure that the current setup includes the System namespace. The only assembly, other than the OpenSim specific ones, that is loaded is System.Collections.Generic. I had to add System before I could even use Exceptions, which seems to indicate that only parts of System that are pulled in are the parts used by the other assemblies that are loaded. Melanie's response (which I mostly agree with) is why I didn't post it on the Wiki. This isn't something the average user (specifically OpenGrid users) should probably be doing. But rather than saying absolutely not, I have to wonder if there's some reasonable middle ground that can do the job of both 1) protecting the average installation from arbitrary library code inclusion/execution, and 2) allowing an easier way to include that facility, for users that -do- need it, as a way for others to make OpenSim more flexible. Compile-time isn't a show-stopper, but something that makes the process easier, like a module, or something in the build system/environment like an scriptengine_additional_libraries variable might be handy. Basically, narrowing down a potential point of failure to one place, instead of three. Thanks again though, my team here really appreciates all the hard work you all put into this. --Jeremy Lothian On Thu, May 27, 2010 at 8:11 PM, Justin Clark-Casey jjusti...@googlemail.com wrote: Melanie wrote: A generic means to add extra libs would be highly DANGEROUS. It definitely needs to be compile-time. Probably has to be, anyway, from the way the scripts work. C# scripts are insecure anyway since anybody who can create them has access to the System namespaces. They are still useful in contexts where script creation and editing are restricted or all parties are highly trusted. Melanie Justin Clark-Casey wrote: J Lothian wrote: Justin, Thanks for pointing me in a direction, this was -very- helpful. It wasn't nearly as straightforward as I was expecting, but it did give me the opportunity/excuse to get my hands dirty and dig into the projects and code a bit. I'm going to document the process a bit here, so it gets archived for future reference. I'm pretty sure I've narrowed down the steps needed. The actual project that needs the assembly reference added to it is OpenSim.Region.ScriptEngine.Shared.CodeTools, but this is just the start. This gets the assembly detectable by the compiler. The next step is adding the reference to the script being compiled. In OpenSim.Region.ScriptEngine.Shared.CodeTools.Compiler (Compiler.cs), in the function CompileFromDotNetText, there is a section where ReferencedAssemblies are added to the compiler as parameters, and the assembly needs to be added here as well. For example, to add a standard library, the following line would be used: parameters.ReferencedAssemblies.Add(System.dll); Which, it turns out, I needed to do, as System.dll isn't added by default, and our test script included a try/catch where Exception was not detected as a type. To add something like the MySql dll that comes with OpenSim, it would look like this: parameters.ReferencedAssemblies.Add( Path.Combine(rootPath,MySql.Data.dll));The script engine automatically wraps scripts in boilerplate code to put them inside a class and make them compilable. This has the side-effect of making using or import statements inside scripts impossible, so these also need to be added to the code. For example, if your script is C#, then the function to alter is CreateCSCompilerScript (in the same Compile.cs), adding the using statement to the list inside this function. If I get the chance later this summer, I may try to develop a more robust system that attempts to (at the very least) detect the default mono/.net libraries and automatically adjust this boilerplate to include them... Again, thanks for the help! Glad that was of some use! Would very much look forward to a boilerplate adjuster - being able to include extra libraries from OpenSim C# 'scripts' would be really useful. Also, it would be great if you could copy the above into a new wiki page off http://opensimulator.org/wiki/Developer_Documentation#Scripting. Things tend to stay a little bit more visible there. Thanks! ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev -- Justin Clark-Casey (justincc) http://justincc.org http://twitter.com/justincc ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev
Re: [Opensim-dev] Adding an assembly reference to make available via script
J Lothian wrote: Greetings, I'm a developer working on a research project that we are migrating from Second Life to OpenSim. We're currently exploring options and new features that may be available in OpenSim that we did not have in Second Life. One of these items is the ability to add a custom assembly reference to be available for scripts within the scripting engine (in C# mode). I am very unfamiliar with the mono/nant build process. I searched for this question a bit and couldn't find anything very related. Could someone point me towards which files I should be looking at to add an assembly reference? Is this even possible? Also, apologies if this is the wrong list, I wasn't sure if this was a user or developer question. If you want to directly call your own C# assembly from within C# scripts, then I believe that you would have to explicitly add those assemblies to prebuild.xml before regenerating the solution files with prebuild.sh/prebuild.bat. The project you would need to add to is OpenSim.Region.ScriptEngine.Shared.Api, I think. However, some of this is supposition - I've never tried this before. I don't think there is any documentation on it. -- Justin Clark-Casey (justincc) http://justincc.org http://twitter.com/justincc ___ Opensim-dev mailing list Opensim-dev@lists.berlios.de https://lists.berlios.de/mailman/listinfo/opensim-dev
