mirror of
https://github.com/opensim/opensim.git
synced 2026-05-16 03:36:04 +08:00
8ccc12d642
Added VISUAL BASIC.NET-support //cs, //lsl and //vb as first characters of script will determine what compiler is used. Compile warnings are no longer treated as errors. Script will still run. Added a few useless and useful config options: Write script source to harddisk for debug, Default compile language, Allowed compilers (languages), compile in release or debug mode, clean up old scripts on startup Loads of warnings for incorrect config
349 lines
15 KiB
C#
349 lines
15 KiB
C#
/*
|
|
* Copyright (c) Contributors, http://opensimulator.org/
|
|
* See CONTRIBUTORS.TXT for a full list of copyright holders.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* * Neither the name of the OpenSim Project nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS AS IS AND ANY
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
|
|
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
|
|
using System;
|
|
using System.CodeDom.Compiler;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.IO;
|
|
using System.Reflection;
|
|
using Microsoft.CSharp;
|
|
using Microsoft.VisualBasic;
|
|
|
|
namespace OpenSim.Region.ScriptEngine.DotNetEngine.Compiler.LSL
|
|
{
|
|
public class Compiler
|
|
{
|
|
|
|
// * Uses "LSL2Converter" to convert LSL to C# if necessary.
|
|
// * Compiles C#-code into an assembly
|
|
// * Returns assembly name ready for AppDomain load.
|
|
//
|
|
// Assembly is compiled using LSL_BaseClass as base. Look at debug C# code file created when LSL script is compiled for full details.
|
|
//
|
|
|
|
internal enum enumCompileType
|
|
{
|
|
lsl = 0,
|
|
cs = 1,
|
|
vb = 2
|
|
}
|
|
private enumCompileType DefaultCompileLanguage;
|
|
private bool WriteScriptSourceToDebugFile;
|
|
private bool CompileWithDebugInformation;
|
|
private bool CleanUpOldScriptsOnStartup;
|
|
private System.Collections.Generic.Dictionary<string, Boolean> AllowedCompilers = new Dictionary<string, bool>(StringComparer.CurrentCultureIgnoreCase);
|
|
private System.Collections.Generic.Dictionary<string, enumCompileType> LanguageMapping = new Dictionary<string, enumCompileType>(StringComparer.CurrentCultureIgnoreCase);
|
|
|
|
private string FilePrefix;
|
|
private string ScriptEnginesPath = "ScriptEngines";
|
|
|
|
private static LSL2CSConverter LSL_Converter = new LSL2CSConverter();
|
|
private static CSharpCodeProvider CScodeProvider = new CSharpCodeProvider();
|
|
private static VBCodeProvider VBcodeProvider = new VBCodeProvider();
|
|
|
|
private static UInt64 scriptCompileCounter = 0;
|
|
|
|
private static int instanceID = new Random().Next(0, int.MaxValue);
|
|
// Implemented due to peer preassure --- will cause garbage in ScriptEngines folder ;)
|
|
|
|
public Common.ScriptEngineBase.ScriptEngine m_scriptEngine;
|
|
public Compiler(Common.ScriptEngineBase.ScriptEngine scriptEngine)
|
|
{
|
|
m_scriptEngine = scriptEngine;
|
|
ReadConfig();
|
|
}
|
|
public bool in_startup = true;
|
|
public void ReadConfig()
|
|
{
|
|
WriteScriptSourceToDebugFile = m_scriptEngine.ScriptConfigSource.GetBoolean("WriteScriptSourceToDebugFile", true);
|
|
CompileWithDebugInformation = m_scriptEngine.ScriptConfigSource.GetBoolean("CompileWithDebugInformation", true);
|
|
CleanUpOldScriptsOnStartup = m_scriptEngine.ScriptConfigSource.GetBoolean("CleanUpOldScriptsOnStartup", true);
|
|
|
|
// Get file prefix from scriptengine name and make it file system safe:
|
|
FilePrefix = m_scriptEngine.ScriptEngineName;
|
|
foreach (char c in Path.GetInvalidFileNameChars())
|
|
{
|
|
FilePrefix = FilePrefix.Replace(c, '_');
|
|
}
|
|
// First time we start?
|
|
if (in_startup)
|
|
{
|
|
in_startup = false;
|
|
DeleteOldFiles();
|
|
}
|
|
|
|
LanguageMapping.Add("cs", enumCompileType.cs);
|
|
LanguageMapping.Add("vb", enumCompileType.lsl);
|
|
LanguageMapping.Add("lsl", enumCompileType.vb);
|
|
|
|
// Allowed compilers
|
|
string allowedCompilers = m_scriptEngine.ScriptConfigSource.GetString("AllowedCompilers", "lsl;cs;vb");
|
|
AllowedCompilers.Clear();
|
|
foreach (string strl in allowedCompilers.Split(';'))
|
|
{
|
|
string strlan = strl.Trim(" \t".ToCharArray()).ToLower();
|
|
if (!LanguageMapping.ContainsKey(strlan))
|
|
{
|
|
m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName, "Config error. Compiler is unable to recongnize language type \"" + strl + "\" specified in \"AllowedCompilers\".");
|
|
}
|
|
AllowedCompilers.Add(strlan, true);
|
|
}
|
|
if (AllowedCompilers.Count == 0)
|
|
m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName, "Config error. Compiler could not recognize any language in \"AllowedCompilers\". Scripts will not be executed!");
|
|
|
|
// Default language
|
|
string defaultCompileLanguage = m_scriptEngine.ScriptConfigSource.GetString("DefaultCompileLanguage", "lsl").ToLower();
|
|
|
|
// Is this language recognized at all?
|
|
if (!LanguageMapping.ContainsKey(defaultCompileLanguage))
|
|
m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName, "Config error. Default language specified in \"DefaultCompileLanguage\" is not recognized as a valid language. Scripts may not be executed!");
|
|
|
|
// Is this language in allow-list?
|
|
if (!AllowedCompilers.ContainsKey(defaultCompileLanguage))
|
|
{
|
|
m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName,
|
|
"Config error. Default language \"" + defaultCompileLanguage + "\"specified in \"DefaultCompileLanguage\" is not in list of \"AllowedCompilers\". Scripts may not be executed!");
|
|
}
|
|
else
|
|
{
|
|
// LANGUAGE IS IN ALLOW-LIST
|
|
DefaultCompileLanguage = LanguageMapping[defaultCompileLanguage];
|
|
}
|
|
|
|
// We now have an allow-list, a mapping list, and a default language
|
|
|
|
}
|
|
|
|
private void DeleteOldFiles()
|
|
{
|
|
|
|
// CREATE FOLDER IF IT DOESNT EXIST
|
|
if (!Directory.Exists(ScriptEnginesPath))
|
|
{
|
|
try
|
|
{
|
|
Directory.CreateDirectory(ScriptEnginesPath);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName, "Exception trying to create ScriptEngine directory \"" + ScriptEnginesPath + "\": " + ex.ToString());
|
|
}
|
|
}
|
|
|
|
foreach (string file in Directory.GetFiles(ScriptEnginesPath))
|
|
{
|
|
m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName, "FILE FOUND: " + file);
|
|
|
|
if (file.ToLower().StartsWith(FilePrefix + "_compiled_") ||
|
|
file.ToLower().StartsWith(FilePrefix + "_source_"))
|
|
{
|
|
try
|
|
{
|
|
File.Delete(file);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName, "Exception trying delete old script file \"" + file + "\": " + ex.ToString());
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
////private ICodeCompiler icc = codeProvider.CreateCompiler();
|
|
//public string CompileFromFile(string LSOFileName)
|
|
//{
|
|
// switch (Path.GetExtension(LSOFileName).ToLower())
|
|
// {
|
|
// case ".txt":
|
|
// case ".lsl":
|
|
// Common.ScriptEngineBase.Common.SendToDebug("Source code is LSL, converting to CS");
|
|
// return CompileFromLSLText(File.ReadAllText(LSOFileName));
|
|
// case ".cs":
|
|
// Common.ScriptEngineBase.Common.SendToDebug("Source code is CS");
|
|
// return CompileFromCSText(File.ReadAllText(LSOFileName));
|
|
// default:
|
|
// throw new Exception("Unknown script type.");
|
|
// }
|
|
//}
|
|
|
|
/// <summary>
|
|
/// Converts script from LSL to CS and calls CompileFromCSText
|
|
/// </summary>
|
|
/// <param name="Script">LSL script</param>
|
|
/// <returns>Filename to .dll assembly</returns>
|
|
public string PerformScriptCompile(string Script)
|
|
{
|
|
enumCompileType l = DefaultCompileLanguage;
|
|
|
|
|
|
if (Script.StartsWith("//c#", true, CultureInfo.InvariantCulture))
|
|
l = enumCompileType.cs;
|
|
if (Script.StartsWith("//vb", true, CultureInfo.InvariantCulture))
|
|
l = enumCompileType.vb;
|
|
if (Script.StartsWith("//lsl", true, CultureInfo.InvariantCulture))
|
|
l = enumCompileType.lsl;
|
|
|
|
if (!AllowedCompilers.ContainsKey(l.ToString()))
|
|
{
|
|
// Not allowed to compile to this language!
|
|
string errtext = String.Empty;
|
|
errtext += "The compiler for language \"" + l.ToString() + "\" is not in list of allowed compilers. Script will not be executed!";
|
|
throw new Exception(errtext);
|
|
}
|
|
|
|
string compileScript;
|
|
|
|
if (l == enumCompileType.lsl)
|
|
{
|
|
// Its LSL, convert it to C#
|
|
compileScript = LSL_Converter.Convert(Script);
|
|
l = enumCompileType.cs;
|
|
}
|
|
else
|
|
{
|
|
// We don't need to convert
|
|
compileScript = Script;
|
|
}
|
|
return CompileFromCSorVBText(Script, l);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Compile CS script to .Net assembly (.dll)
|
|
/// </summary>
|
|
/// <param name="Script">CS script</param>
|
|
/// <returns>Filename to .dll assembly</returns>
|
|
internal string CompileFromCSorVBText(string Script, enumCompileType lang)
|
|
{
|
|
string ext = "." + lang.ToString();
|
|
|
|
// Output assembly name
|
|
scriptCompileCounter++;
|
|
string OutFile =
|
|
Path.Combine("ScriptEngines",
|
|
FilePrefix + "_compiled_" + instanceID.ToString() + "_" + scriptCompileCounter.ToString() + ".dll");
|
|
try
|
|
{
|
|
File.Delete(OutFile);
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
//m_scriptEngine.Log.Error(m_scriptEngine.ScriptEngineName, "Unable to delete old existring script-file before writing new. Compile aborted: " + e.ToString());
|
|
throw new Exception("Unable to delete old existring script-file before writing new. Compile aborted: " + e.ToString());
|
|
}
|
|
//string OutFile = Path.Combine("ScriptEngines", "SecondLife.Script.dll");
|
|
|
|
// DEBUG - write source to disk
|
|
if (WriteScriptSourceToDebugFile)
|
|
{
|
|
try
|
|
{
|
|
File.WriteAllText(
|
|
Path.Combine("ScriptEngines", FilePrefix + "_source_" + Path.GetFileNameWithoutExtension(OutFile) + ext),
|
|
Script);
|
|
}
|
|
catch
|
|
{
|
|
}
|
|
}
|
|
|
|
// Do actual compile
|
|
CompilerParameters parameters = new CompilerParameters();
|
|
|
|
parameters.IncludeDebugInformation = true;
|
|
|
|
// Add all available assemblies
|
|
foreach (Assembly asm in AppDomain.CurrentDomain.GetAssemblies())
|
|
{
|
|
//Console.WriteLine("Adding assembly: " + asm.Location);
|
|
//parameters.ReferencedAssemblies.Add(asm.Location);
|
|
}
|
|
|
|
string rootPath = Path.GetDirectoryName(AppDomain.CurrentDomain.BaseDirectory);
|
|
string rootPathSE = Path.GetDirectoryName(GetType().Assembly.Location);
|
|
//Console.WriteLine("Assembly location: " + rootPath);
|
|
parameters.ReferencedAssemblies.Add(Path.Combine(rootPath, "OpenSim.Region.ScriptEngine.Common.dll"));
|
|
parameters.ReferencedAssemblies.Add(Path.Combine(rootPathSE, "OpenSim.Region.ScriptEngine.DotNetEngine.dll"));
|
|
|
|
//parameters.ReferencedAssemblies.Add("OpenSim.Region.Environment");
|
|
parameters.GenerateExecutable = false;
|
|
parameters.OutputAssembly = OutFile;
|
|
parameters.IncludeDebugInformation = CompileWithDebugInformation;
|
|
parameters.WarningLevel = 4;
|
|
parameters.TreatWarningsAsErrors = false;
|
|
|
|
CompilerResults results;
|
|
switch (lang)
|
|
{
|
|
case enumCompileType.vb:
|
|
results = VBcodeProvider.CompileAssemblyFromSource(parameters, Script);
|
|
break;
|
|
case enumCompileType.cs:
|
|
results = CScodeProvider.CompileAssemblyFromSource(parameters, Script);
|
|
break;
|
|
default:
|
|
throw new Exception("Compiler is not able to recongnize language type \"" + lang.ToString() + "\"");
|
|
}
|
|
|
|
// Check result
|
|
// Go through errors
|
|
|
|
//
|
|
// WARNINGS AND ERRORS
|
|
//
|
|
if (results.Errors.Count > 0)
|
|
{
|
|
string errtext = String.Empty;
|
|
foreach (CompilerError CompErr in results.Errors)
|
|
{
|
|
errtext += "Line number " + (CompErr.Line - 1) +
|
|
", Error Number: " + CompErr.ErrorNumber +
|
|
", '" + CompErr.ErrorText + "'\r\n";
|
|
}
|
|
if (!File.Exists(OutFile))
|
|
{
|
|
throw new Exception(errtext);
|
|
}
|
|
}
|
|
|
|
|
|
//
|
|
// NO ERRORS, BUT NO COMPILED FILE
|
|
//
|
|
if (!File.Exists(OutFile))
|
|
{
|
|
string errtext = String.Empty;
|
|
errtext += "No compile error. But not able to locate compiled file.";
|
|
throw new Exception(errtext);
|
|
}
|
|
return OutFile;
|
|
}
|
|
}
|
|
} |