├── .gitignore ├── .github └── workflows │ └── build.yml ├── README.md ├── autoexecconfig.sp ├── autoexecconfig.inc └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # SourcePawn 2 | changelog.txt 3 | todo.txt 4 | *.smx -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build include 2 | on: [push] 3 | 4 | jobs: 5 | build: 6 | runs-on: ubuntu-latest 7 | strategy: 8 | matrix: 9 | sm-version: ["1.10.x", "1.11.x"] 10 | 11 | name: SM version ${{ matrix.sm-version }} 12 | steps: 13 | - uses: actions/checkout@v3 14 | 15 | - name: Setup SP 16 | uses: rumblefrog/setup-sp@v1.2.2 17 | with: 18 | version: ${{ matrix.sm-version }} 19 | 20 | - run: spcomp autoexecconfig.sp 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AutoExecConfig 2 | An includefile to read and append to autoconfigs created by sourcemod. 3 | 4 | ![Build include](https://github.com/Impact123/AutoExecConfig/workflows/Build%20include/badge.svg) 5 | 6 | ## How does it work? 7 | If you add a convar via `AutoExecConfig_CreateConVar` it will be searched in the autoconfigfile you have set before. 8 | If it can't be found within the file, it will add it with the information you created the convar with. 9 | After that the file can be cleaned from unneccessary whitespaces created by the user or autoexecconfig itself. 10 | The autoexecconfig.sp might contain useful information. 11 | 12 | 13 | 14 | ## Implementing 15 | One thing i had in mind while writing this was easy implementation. For basic usage you only have to add 2 lines and rename the command you created your convars with. 16 | 17 | ### An example 18 | 19 | Let's assume you already wrote a plugin with some convars which might look like this. 20 | 21 | ```SourcePawn 22 | public OnPluginStart() 23 | { 24 | CreateConVar("sm_myplugin_enabled", "1", "Whether or not this plugin is enabled"); 25 | CreateConVar("sm_myplugin_chattrigger", "myplugin", "Chattrigger to open the menu of this plugin"); 26 | CreateConVar("sm_myplugin_adminflag", "b", "Adminflag needed to use the chattrigger"); 27 | 28 | AutoExecConfig(true, "plugin.myplugin"); 29 | } 30 | ``` 31 | 32 | In order to use this include it would simply have to be changed to this: 33 | 34 | ```SourcePawn 35 | public OnPluginStart() 36 | { 37 | // Sets the file for the include, must be done before using most other functions 38 | // The .cfg file extension can be left off 39 | AutoExecConfig_SetFile("plugin.myplugin"); 40 | 41 | AutoExecConfig_CreateConVar("sm_myplugin_enabled", "1", "Whether or not this plugin is enabled"); 42 | AutoExecConfig_CreateConVar("sm_myplugin_chattrigger", "myplugin", "Chattrigger to open the menu of this plugin"); 43 | AutoExecConfig_CreateConVar("sm_myplugin_adminflag", "b", "Adminflag needed to use the chattrigger"); 44 | 45 | // Uses AutoExecConfig internally using the file set by AutoExecConfig_SetFile 46 | AutoExecConfig_ExecuteFile(); 47 | 48 | // Cleaning is an optional operation that removes whitespaces that might have been introduced and formats the file in a certain way 49 | // It is an expensive operation (file operations is relatively slow) and should be done at the end when the file will not be written to anymore 50 | AutoExecConfig_CleanFile(); 51 | } 52 | ``` 53 | 54 | ## Notes 55 | * The parser will ignore spaces between cvars and values, inside values or behind values for security. 56 | * The search of the parser, by default, is case sensitive. 57 | * Convars with a FCVAR_DONTRECORD flag will be skipped by the appender. 58 | * The cleaner will format your file the way autoexecconfig does, 2 spaces after information, 1 after cvars. 59 | -------------------------------------------------------------------------------- /autoexecconfig.sp: -------------------------------------------------------------------------------- 1 | /** 2 | * AutoExecConfig 3 | * 4 | * Copyright (C) 2013-2019 Impact 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see 18 | */ 19 | 20 | #include 21 | #include 22 | 23 | #pragma semicolon 1 24 | #pragma newdecls required 25 | #include "autoexecconfig" 26 | 27 | 28 | Handle g_hProf; 29 | 30 | 31 | 32 | public Plugin myinfo = 33 | { 34 | name = "AutoExecConfig Testsuite", 35 | author = "Impact", 36 | description = "Tests the autoexecconfig include", 37 | version = AUTOEXECCONFIG_VERSION, 38 | url = AUTOEXECCONFIG_URL 39 | } 40 | 41 | 42 | 43 | public void OnPluginStart() 44 | { 45 | g_hProf = CreateProfiler(); 46 | StartProfiling(g_hProf); 47 | 48 | 49 | bool appended; 50 | bool error; 51 | 52 | 53 | // Order of this is important, the setting has to be known before we set the file path 54 | AutoExecConfig_SetCreateDirectory(true); 55 | 56 | // We want to let the include file create the file if it doesn't exists already, otherwise we let sourcemod create it 57 | AutoExecConfig_SetCreateFile(true); 58 | 59 | // Set file, extension is optional aswell as the second parameter which defaults to sourcemod 60 | AutoExecConfig_SetFile("autoexecconfigtest", "sourcemod"); 61 | 62 | 63 | AutoExecConfig_CreateConVar("listme", "Avalue", "A description"); 64 | SetAppend(appended); 65 | SetError(error); 66 | 67 | AutoExecConfig_CreateConVar("listme2", "Anothervalue", "An other description"); 68 | SetAppend(appended); 69 | SetError(error); 70 | 71 | AutoExecConfig_CreateConVar("boundtest", "Anothervaluetoo", "Cvar for boundtest", FCVAR_NONE, true, 5.0, true, 10.0); 72 | SetAppend(appended); 73 | SetError(error); 74 | 75 | AutoExecConfig_CreateConVar("newlinetest", "SomeCvar", "This\nIs\nA\nNewline\nTest", FCVAR_NONE); 76 | SetAppend(appended); 77 | SetError(error); 78 | 79 | AutoExecConfig_CreateConVar("CaSeSeNsItIvEtEsT", "Casesensitivecvar", "Weird written cvar with bounds", FCVAR_NONE, false, 0.0, true, 12.5); 80 | SetAppend(appended); 81 | SetError(error); 82 | 83 | AutoExecConfig_CreateConVar("LongDescriptionTest", "LongDescxyz", "Really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, really, long description", FCVAR_NONE, false, 4.0, true, 53.5); 84 | SetAppend(appended); 85 | SetError(error); 86 | 87 | AutoExecConfig_CreateConVar("321isgreaterthan123", "Anothervalue", "Convar with numbers"); 88 | SetAppend(appended); 89 | SetError(error); 90 | 91 | AutoExecConfig_CreateConVar("%%%somespecialconvar%%%", "%%%somevalue%%%", "Convar with percent signs"); 92 | SetAppend(appended); 93 | SetError(error); 94 | 95 | 96 | 97 | // Execute the given config 98 | AutoExecConfig_ExecuteFile(); 99 | 100 | 101 | 102 | // Cleaning is an relatively expensive file operation 103 | if (appended) 104 | { 105 | PrintToServer("Some convars were appended to the config, clean it up"); 106 | AutoExecConfig_CleanFile(); 107 | } 108 | 109 | if (error) 110 | { 111 | PrintToServer("Non successfull result occured, last find/append result: %d, %d", AutoExecConfig_GetFindResult(), AutoExecConfig_GetAppendResult()); 112 | } 113 | 114 | 115 | 116 | StopProfiling(g_hProf); 117 | 118 | float fProfilerTime = GetProfilerTime(g_hProf); 119 | PrintToServer("Benchmark: %f seconds, %f milliseconds", fProfilerTime, fProfilerTime * 1000); 120 | PrintToServer("Benchmark needed approximately %f %% of 1 Second", CalculateFloatPercentage(fProfilerTime, 0.01)); 121 | PrintToServer("Benchmark needed approximately %f %% of 1 Frame", CalculateFloatPercentage(fProfilerTime, 0.01 / 66.7)); 122 | } 123 | 124 | 125 | 126 | void SetAppend(bool &appended) 127 | { 128 | if (AutoExecConfig_GetAppendResult() == AUTOEXEC_APPEND_SUCCESS) 129 | { 130 | appended = true; 131 | } 132 | } 133 | 134 | 135 | void SetError(bool &error) 136 | { 137 | int findRes = AutoExecConfig_GetAppendResult(); 138 | int appendRes = AutoExecConfig_GetFindResult(); 139 | 140 | if ( (findRes != -1 && findRes != AUTOEXEC_APPEND_SUCCESS) || 141 | (appendRes != -1 && appendRes != AUTOEXEC_FIND_SUCCESS) ) 142 | { 143 | error = true; 144 | } 145 | } 146 | 147 | 148 | 149 | stock float CalculateFloatPercentage(float value1, float value2) 150 | { 151 | if (value1 == 0.0 || value2 == 0.0) 152 | { 153 | return 0.0; 154 | } 155 | 156 | return (value1 / value2); 157 | } -------------------------------------------------------------------------------- /autoexecconfig.inc: -------------------------------------------------------------------------------- 1 | /** 2 | * AutoExecConfig 3 | * 4 | * Copyright (C) 2013-2023 Impact 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see 18 | */ 19 | 20 | #if defined _autoexecconfig_included 21 | #endinput 22 | #endif 23 | #define _autoexecconfig_included 24 | 25 | 26 | #include 27 | 28 | #pragma semicolon 1 29 | #pragma newdecls required 30 | 31 | #define AUTOEXECCONFIG_VERSION "0.1.6" 32 | #define AUTOEXECCONFIG_URL "https://forums.alliedmods.net/showthread.php?t=204254" 33 | 34 | // Append 35 | #define AUTOEXEC_APPEND_BAD_FILENAME 0 36 | #define AUTOEXEC_APPEND_FILE_NOT_FOUND 1 37 | #define AUTOEXEC_APPEND_BAD_HANDLE 2 38 | #define AUTOEXEC_APPEND_SUCCESS 3 39 | 40 | 41 | 42 | // Find 43 | #define AUTOEXEC_FIND_BAD_FILENAME 10 44 | #define AUTOEXEC_FIND_FILE_NOT_FOUND 11 45 | #define AUTOEXEC_FIND_BAD_HANDLE 12 46 | #define AUTOEXEC_FIND_NOT_FOUND 13 47 | #define AUTOEXEC_FIND_SUCCESS 14 48 | 49 | 50 | 51 | // Clean 52 | #define AUTOEXEC_CLEAN_FILE_NOT_FOUND 20 53 | #define AUTOEXEC_CLEAN_BAD_HANDLE 21 54 | #define AUTOEXEC_CLEAN_SUCCESS 22 55 | 56 | 57 | 58 | // General 59 | #define AUTOEXEC_NO_CONFIG 30 60 | 61 | 62 | 63 | // Formatter 64 | #define AUTOEXEC_FORMAT_BAD_FILENAME 40 65 | #define AUTOEXEC_FORMAT_SUCCESS 41 66 | 67 | 68 | 69 | // Global variables 70 | static char g_sConfigFile[PLATFORM_MAX_PATH]; 71 | static char g_sRawFileName[PLATFORM_MAX_PATH]; 72 | static char g_sFolderPath[PLATFORM_MAX_PATH]; 73 | 74 | static bool g_bCreateFile = false; 75 | static Handle g_hPluginHandle = null; 76 | 77 | static bool g_bCreateDirectory = false; 78 | static int g_bCreateDirectoryMode = FPERM_U_READ|FPERM_U_WRITE|FPERM_U_EXEC|FPERM_G_READ|FPERM_G_EXEC|FPERM_O_READ|FPERM_O_EXEC; 79 | 80 | 81 | // Workaround for now 82 | static int g_iLastFindResult; 83 | static int g_iLastAppendResult; 84 | 85 | 86 | 87 | 88 | /** 89 | * Returns the last result from the parser. 90 | * 91 | * @return Returns one of the AUTOEXEC_FIND values or -1 if not set. 92 | */ 93 | stock int AutoExecConfig_GetFindResult() 94 | { 95 | return g_iLastFindResult; 96 | } 97 | 98 | 99 | 100 | 101 | 102 | /** 103 | * Returns the last result from the appender. 104 | * 105 | * @return Returns one of the AUTOEXEC_APPEND values or -1 if not set. 106 | */ 107 | stock int AutoExecConfig_GetAppendResult() 108 | { 109 | return g_iLastAppendResult; 110 | } 111 | 112 | 113 | /** 114 | * Set if the config file should be created by the autoexecconfig include itself if it doesn't exist. 115 | * 116 | * @param create True if config file should be created, false otherwise. 117 | * @noreturn 118 | */ 119 | stock void AutoExecConfig_SetCreateFile(bool create) 120 | { 121 | g_bCreateFile = create; 122 | } 123 | 124 | 125 | /** 126 | * Set if the config file's folder should be created by the autoexecconfig include itself if it doesn't exist. 127 | * Note: Must be used before AutoExecConfig_SetFile as the potential creation of it happens there 128 | * 129 | * @param create True if config file should be created, false otherwise. 130 | * @param mode Folder permission mode, default is u=rwx,g=rx,o=rx. 131 | * @noreturn 132 | */ 133 | stock void AutoExecConfig_SetCreateDirectory(bool create, int mode=FPERM_U_READ|FPERM_U_WRITE|FPERM_U_EXEC|FPERM_G_READ|FPERM_G_EXEC|FPERM_O_READ|FPERM_O_EXEC) 134 | { 135 | g_bCreateDirectory = create; 136 | g_bCreateDirectoryMode = mode; 137 | } 138 | 139 | 140 | /** 141 | * Returns if the config file should be created if it doesn't exist. 142 | * 143 | * @return Returns true, if the config file should be created or false if it should not. 144 | */ 145 | stock bool AutoExecConfig_GetCreateFile() 146 | { 147 | return g_bCreateFile; 148 | } 149 | 150 | 151 | /** 152 | * Set the plugin for which the config file should be created. 153 | * Set to null to use the calling plugin. 154 | * Used to print the correct filename in the top comment when creating the file. 155 | * 156 | * @param plugin The plugin to create convars for or null to use the calling plugin. 157 | * @noreturn 158 | */ 159 | stock void AutoExecConfig_SetPlugin(Handle plugin) 160 | { 161 | g_hPluginHandle = plugin; 162 | } 163 | 164 | 165 | /** 166 | * Returns the plugin's handle for which the config file is created. 167 | * 168 | * @return The plugin handle 169 | */ 170 | stock Handle AutoExecConfig_GetPlugin() 171 | { 172 | return g_hPluginHandle; 173 | } 174 | 175 | 176 | /** 177 | * Set the global autoconfigfile used by functions of this file. 178 | * Note: does not support subfolders like folder1/folder2 179 | * 180 | * @param file Name of the config file, path and .cfg extension is being added if not given. 181 | * @param folder Folder under cfg/ to use. By default this is "sourcemod." 182 | * @return True if formatter returned success, false otherwise. 183 | */ 184 | stock bool AutoExecConfig_SetFile(char[] file, char[] folder="sourcemod") 185 | { 186 | Format(g_sConfigFile, sizeof(g_sConfigFile), "%s", file); 187 | 188 | // Global buffers for cfg execution 189 | strcopy(g_sRawFileName, sizeof(g_sRawFileName), file); 190 | strcopy(g_sFolderPath, sizeof(g_sFolderPath), folder); 191 | 192 | 193 | // Format the filename 194 | return AutoExecConfig_FormatFileName(g_sConfigFile, sizeof(g_sConfigFile), folder) == AUTOEXEC_FORMAT_SUCCESS; 195 | } 196 | 197 | 198 | 199 | 200 | 201 | 202 | /** 203 | * Get the formatted autoconfigfile used by functions of this file. 204 | * 205 | * @param buffer String to format. 206 | * @param size Maximum size of buffer 207 | * @return True if filename was set, false otherwise. 208 | */ 209 | stock bool AutoExecConfig_GetFile(char[] buffer,int size) 210 | { 211 | if (strlen(g_sConfigFile) > 0) 212 | { 213 | strcopy(buffer, size, g_sConfigFile); 214 | 215 | return true; 216 | } 217 | 218 | // Security for decl users 219 | buffer[0] = '\0'; 220 | 221 | return false; 222 | } 223 | 224 | 225 | 226 | 227 | 228 | 229 | /** 230 | * Creates a convar and appends it to the autoconfigfile if not found. 231 | * FCVAR_DONTRECORD will be skipped. 232 | * 233 | * @param name Name of new convar. 234 | * @param defaultValue String containing the default value of new convar. 235 | * @param description Optional description of the convar. 236 | * @param flags Optional bitstring of flags determining how the convar should be handled. See FCVAR_* constants for more details. 237 | * @param hasMin Optional boolean that determines if the convar has a minimum value. 238 | * @param min Minimum floating point value that the convar can have if hasMin is true. 239 | * @param hasMax Optional boolean that determines if the convar has a maximum value. 240 | * @param max Maximum floating point value that the convar can have if hasMax is true. 241 | * @return A handle to the newly created convar. If the convar already exists, a handle to it will still be returned. 242 | * @error Convar name is blank or is the same as an existing console command. 243 | */ 244 | stock ConVar AutoExecConfig_CreateConVar(const char[] name, const char[] defaultValue, const char[] description="", int flags=0, bool hasMin=false, float min=0.0, bool hasMax=false, float max=0.0) 245 | { 246 | // If configfile was set and convar has no dontrecord flag 247 | if (!(flags & FCVAR_DONTRECORD) && strlen(g_sConfigFile) > 0) 248 | { 249 | // Reset the results 250 | g_iLastFindResult = -1; 251 | g_iLastAppendResult = -1; 252 | 253 | 254 | // Add it if not found 255 | char buffer[64]; 256 | 257 | g_iLastFindResult = AutoExecConfig_FindValue(name, buffer, sizeof(buffer), true); 258 | 259 | // We only add this convar if it doesn't exist, or the file doesn't exist and it should be auto-generated 260 | if (g_iLastFindResult == AUTOEXEC_FIND_NOT_FOUND || (g_iLastFindResult == AUTOEXEC_FIND_FILE_NOT_FOUND && g_bCreateFile)) 261 | { 262 | g_iLastAppendResult = AutoExecConfig_AppendValue(name, defaultValue, description, flags, hasMin, min, hasMax, max); 263 | } 264 | } 265 | 266 | 267 | // Create the convar 268 | return CreateConVar(name, defaultValue, description, flags, hasMin, min, hasMax, max); 269 | } 270 | 271 | 272 | 273 | 274 | /** 275 | * Executes the autoconfigfile and adds it to the OnConfigsExecuted forward. 276 | * If we didn't create it ourselves we let SourceMod create it. 277 | * 278 | * @noreturn 279 | */ 280 | stock void AutoExecConfig_ExecuteFile() 281 | { 282 | // Only let sourcemod create the file, if we didn't do that already. 283 | AutoExecConfig(!g_bCreateFile, g_sRawFileName, g_sFolderPath); 284 | } 285 | 286 | 287 | 288 | 289 | 290 | /** 291 | * Formats a autoconfigfile, prefixes path and adds .cfg extension if missing. 292 | * 293 | * @param buffer String to format. 294 | * @param size Maximum size of buffer. 295 | * @return Returns one of the AUTOEXEC_FORMAT values.. 296 | */ 297 | stock static int AutoExecConfig_FormatFileName(char[] buffer, int size, char[] folder="sourcemod") 298 | { 299 | // No config set 300 | if (strlen(g_sConfigFile) < 1) 301 | { 302 | return AUTOEXEC_NO_CONFIG; 303 | } 304 | 305 | 306 | // Can't be an cfgfile 307 | if (StrContains(g_sConfigFile, ".cfg") != -1 && strlen(g_sConfigFile) < 4) 308 | { 309 | return AUTOEXEC_FORMAT_BAD_FILENAME; 310 | } 311 | 312 | 313 | // Pathprefix 314 | char pathprefixbuffer[PLATFORM_MAX_PATH]; 315 | if (strlen(folder) > 0) 316 | { 317 | Format(pathprefixbuffer, sizeof(pathprefixbuffer), "cfg/%s/", folder); 318 | 319 | if (g_bCreateDirectory && !DirExists(pathprefixbuffer)) 320 | { 321 | CreateDirectory(pathprefixbuffer, g_bCreateDirectoryMode); 322 | } 323 | } 324 | else 325 | { 326 | Format(pathprefixbuffer, sizeof(pathprefixbuffer), "cfg/"); 327 | } 328 | 329 | 330 | char filebuffer[PLATFORM_MAX_PATH]; 331 | filebuffer[0] = '\0'; 332 | 333 | // Add path if file doesn't begin with it 334 | if (StrContains(buffer, pathprefixbuffer) != 0) 335 | { 336 | StrCat(filebuffer, sizeof(filebuffer), pathprefixbuffer); 337 | } 338 | 339 | StrCat(filebuffer, sizeof(filebuffer), g_sConfigFile); 340 | 341 | 342 | // Add .cfg extension if file doesn't end with it 343 | if (StrContains(filebuffer[strlen(filebuffer) - 4], ".cfg") != 0) 344 | { 345 | StrCat(filebuffer, sizeof(filebuffer), ".cfg"); 346 | } 347 | 348 | strcopy(buffer, size, filebuffer); 349 | 350 | return AUTOEXEC_FORMAT_SUCCESS; 351 | } 352 | 353 | 354 | 355 | 356 | 357 | 358 | /** 359 | * Appends a convar to the global autoconfigfile 360 | * 361 | * @param name Name of new convar. 362 | * @param defaultValue String containing the default value of new convar. 363 | * @param description Optional description of the convar. 364 | * @param flags Optional bitstring of flags determining how the convar should be handled. See FCVAR_* constants for more details. 365 | * @param hasMin Optional boolean that determines if the convar has a minimum value. 366 | * @param min Minimum floating point value that the convar can have if hasMin is true. 367 | * @param hasMax Optional boolean that determines if the convar has a maximum value. 368 | * @param max Maximum floating point value that the convar can have if hasMax is true. 369 | * @return Returns one of the AUTOEXEC_APPEND values 370 | */ 371 | stock int AutoExecConfig_AppendValue(const char[] name, const char[] defaultValue, const char[] description, int flags, bool hasMin, float min, bool hasMax, float max) 372 | { 373 | // No config set 374 | if (strlen(g_sConfigFile) < 1) 375 | { 376 | return AUTOEXEC_NO_CONFIG; 377 | } 378 | 379 | 380 | char filebuffer[PLATFORM_MAX_PATH]; 381 | strcopy(filebuffer, sizeof(filebuffer), g_sConfigFile); 382 | 383 | 384 | //PrintToServer("pathbuffer: %s", filebuffer); 385 | 386 | bool bFileExists = FileExists(filebuffer); 387 | 388 | if (g_bCreateFile || bFileExists) 389 | { 390 | // If the file already exists we open it in append mode, otherwise we use a write mode which creates the file 391 | File fFile = OpenFile(filebuffer, (bFileExists ? "a" : "w")); 392 | char writebuffer[2048]; 393 | 394 | 395 | if (fFile == null) 396 | { 397 | return AUTOEXEC_APPEND_BAD_HANDLE; 398 | } 399 | 400 | // We just created the file, so add some header about version and stuff 401 | if (g_bCreateFile && !bFileExists) 402 | { 403 | fFile.WriteLine( "// This file was auto-generated by AutoExecConfig v%s (%s)", AUTOEXECCONFIG_VERSION, AUTOEXECCONFIG_URL); 404 | 405 | GetPluginFilename(g_hPluginHandle, writebuffer, sizeof(writebuffer)); 406 | Format(writebuffer, sizeof(writebuffer), "// ConVars for plugin \"%s\"", writebuffer); 407 | fFile.WriteLine("%s", writebuffer); 408 | } 409 | 410 | // Spacer 411 | fFile.WriteLine("\n"); 412 | 413 | 414 | // This is used for multiline comments 415 | int newlines = GetCharCountInStr('\n', description); 416 | if (newlines == 0) 417 | { 418 | // We have no newlines, we can write the description to the file as is 419 | Format(writebuffer, sizeof(writebuffer), "// %s", description); 420 | fFile.WriteLine("%s", writebuffer); 421 | } 422 | else 423 | { 424 | char[][] newlineBuf = new char[newlines +1][2048]; 425 | ExplodeString(description, "\n", newlineBuf, newlines +1, 2048, false); 426 | 427 | // Each newline gets a commented newline 428 | for (int i; i <= newlines; i++) 429 | { 430 | if (strlen(newlineBuf[i]) > 0) 431 | { 432 | fFile.WriteLine("// %s", newlineBuf[i]); 433 | } 434 | } 435 | } 436 | 437 | 438 | // Descspacer 439 | fFile.WriteLine("// -"); 440 | 441 | 442 | // Default 443 | Format(writebuffer, sizeof(writebuffer), "// Default: \"%s\"", defaultValue); 444 | fFile.WriteLine("%s", writebuffer); 445 | 446 | 447 | // Minimum 448 | if (hasMin) 449 | { 450 | Format(writebuffer, sizeof(writebuffer), "// Minimum: \"%f\"", min); 451 | fFile.WriteLine("%s", writebuffer); 452 | } 453 | 454 | 455 | // Maximum 456 | if (hasMax) 457 | { 458 | Format(writebuffer, sizeof(writebuffer), "// Maximum: \"%f\"", max); 459 | fFile.WriteLine("%s", writebuffer); 460 | } 461 | 462 | 463 | // Write end and defaultvalue 464 | Format(writebuffer, sizeof(writebuffer), "%s \"%s\"", name, defaultValue); 465 | fFile.WriteLine("%s", writebuffer); 466 | 467 | 468 | fFile.Close(); 469 | 470 | return AUTOEXEC_APPEND_SUCCESS; 471 | } 472 | 473 | return AUTOEXEC_APPEND_FILE_NOT_FOUND; 474 | } 475 | 476 | 477 | 478 | 479 | 480 | 481 | /** 482 | * Returns a convar's value from the global autoconfigfile 483 | * 484 | * @param cvar Cvar to search for. 485 | * @param value Buffer to store result into. 486 | * @param size Maximum size of buffer. 487 | * @param caseSensitive Whether or not the search should be case sensitive. 488 | * @return Returns one of the AUTOEXEC_FIND values 489 | */ 490 | stock int AutoExecConfig_FindValue(const char[] cvar, char[] value, int size, bool caseSensitive=false) 491 | { 492 | // Security for decl users 493 | value[0] = '\0'; 494 | 495 | 496 | // No config set 497 | if (strlen(g_sConfigFile) < 1) 498 | { 499 | return AUTOEXEC_NO_CONFIG; 500 | } 501 | 502 | 503 | char filebuffer[PLATFORM_MAX_PATH]; 504 | strcopy(filebuffer, sizeof(filebuffer), g_sConfigFile); 505 | 506 | 507 | 508 | //PrintToServer("pathbuffer: %s", filebuffer); 509 | 510 | bool bFileExists = FileExists(filebuffer); 511 | 512 | // We want to create the config file and it doesn't exist yet. 513 | if (g_bCreateFile && !bFileExists) 514 | { 515 | return AUTOEXEC_FIND_FILE_NOT_FOUND; 516 | } 517 | 518 | 519 | if (bFileExists) 520 | { 521 | File fFile = OpenFile(filebuffer, "r"); 522 | int valuestart; 523 | int valueend; 524 | int cvarend; 525 | 526 | // Just a reminder to self, leave the values that high 527 | char sConvar[64]; 528 | char sValue[64]; 529 | char readbuffer[2048]; 530 | char copybuffer[2048]; 531 | 532 | if (fFile == null) 533 | { 534 | return AUTOEXEC_FIND_BAD_HANDLE; 535 | } 536 | 537 | 538 | while (!fFile.EndOfFile() && fFile.ReadLine(readbuffer, sizeof(readbuffer))) 539 | { 540 | // Is a comment or not valid 541 | if (IsCharSpace(readbuffer[0]) || readbuffer[0] == '/') 542 | { 543 | continue; 544 | } 545 | 546 | 547 | // Has not enough spaces, must have at least 1 548 | if (GetCharCountInStr(' ', readbuffer) < 1) 549 | { 550 | continue; 551 | } 552 | 553 | 554 | // Ignore cvars which aren't quoted 555 | if (GetCharCountInStr('"', readbuffer) != 2) 556 | { 557 | continue; 558 | } 559 | 560 | 561 | 562 | // Get the start of the value 563 | if ( (valuestart = StrContains(readbuffer, "\"")) == -1 ) 564 | { 565 | continue; 566 | } 567 | 568 | 569 | // Get the end of the value 570 | if ( (valueend = StrContains(readbuffer[valuestart+1], "\"")) == -1 ) 571 | { 572 | continue; 573 | } 574 | 575 | 576 | // Get the start of the cvar, 577 | if ( (cvarend = StrContains(readbuffer, " ")) == -1 || cvarend >= valuestart) 578 | { 579 | continue; 580 | } 581 | 582 | 583 | // Skip if cvarendindex is before valuestartindex 584 | if (cvarend >= valuestart) 585 | { 586 | continue; 587 | } 588 | 589 | 590 | // Convar 591 | // Tempcopy for security 592 | strcopy(copybuffer, sizeof(copybuffer), readbuffer); 593 | copybuffer[cvarend] = '\0'; 594 | 595 | strcopy(sConvar, sizeof(sConvar), copybuffer); 596 | 597 | 598 | // Value 599 | // Tempcopy for security 600 | strcopy(copybuffer, sizeof(copybuffer), readbuffer[valuestart+1]); 601 | copybuffer[valueend] = '\0'; 602 | 603 | strcopy(sValue, sizeof(sValue), copybuffer); 604 | 605 | 606 | //PrintToServer("Cvar %s has a value of %s", sConvar, sValue); 607 | 608 | if (StrEqual(sConvar, cvar, caseSensitive)) 609 | { 610 | Format(value, size, "%s", sConvar); 611 | 612 | fFile.Close(); 613 | return AUTOEXEC_FIND_SUCCESS; 614 | } 615 | } 616 | 617 | fFile.Close(); 618 | return AUTOEXEC_FIND_NOT_FOUND; 619 | } 620 | 621 | 622 | return AUTOEXEC_FIND_FILE_NOT_FOUND; 623 | } 624 | 625 | 626 | 627 | 628 | 629 | 630 | /** 631 | * Cleans the global autoconfigfile from too much spaces 632 | * 633 | * @return One of the AUTOEXEC_CLEAN values. 634 | */ 635 | stock int AutoExecConfig_CleanFile() 636 | { 637 | // No config set 638 | if (strlen(g_sConfigFile) < 1) 639 | { 640 | return AUTOEXEC_NO_CONFIG; 641 | } 642 | 643 | 644 | char sfile[PLATFORM_MAX_PATH]; 645 | strcopy(sfile, sizeof(sfile), g_sConfigFile); 646 | 647 | 648 | // Security 649 | if (!FileExists(sfile)) 650 | { 651 | return AUTOEXEC_CLEAN_FILE_NOT_FOUND; 652 | } 653 | 654 | 655 | 656 | char sfile2[PLATFORM_MAX_PATH]; 657 | Format(sfile2, sizeof(sfile2), "%s_tempcopy", sfile); 658 | 659 | 660 | char readbuffer[2048]; 661 | int count; 662 | bool firstreached; 663 | 664 | 665 | // Open files 666 | File fFile1 = OpenFile(sfile, "r"); 667 | File fFile2 = OpenFile(sfile2, "w"); 668 | 669 | 670 | 671 | // Check filehandles 672 | if (fFile1 == null || fFile2 == null) 673 | { 674 | if (fFile1 != null) 675 | { 676 | //PrintToServer("Handle1 invalid"); 677 | fFile1.Close(); 678 | } 679 | 680 | if (fFile2 != null) 681 | { 682 | //PrintToServer("Handle2 invalid"); 683 | fFile2.Close(); 684 | } 685 | 686 | return AUTOEXEC_CLEAN_BAD_HANDLE; 687 | } 688 | 689 | 690 | 691 | while (!fFile1.EndOfFile() && fFile1.ReadLine(readbuffer, sizeof(readbuffer))) 692 | { 693 | // Is space 694 | if (IsCharSpace(readbuffer[0])) 695 | { 696 | count++; 697 | } 698 | // No space, count from start 699 | else 700 | { 701 | count = 0; 702 | } 703 | 704 | 705 | // Don't write more than 1 space if seperation after informations have been reached 706 | if (count < 2 || !firstreached) 707 | { 708 | ReplaceString(readbuffer, sizeof(readbuffer), "\n", ""); 709 | fFile2.WriteLine("%s", readbuffer); 710 | } 711 | 712 | 713 | // First bigger seperation after informations has been reached 714 | if (count == 2) 715 | { 716 | firstreached = true; 717 | } 718 | } 719 | 720 | 721 | fFile1.Close(); 722 | fFile2.Close(); 723 | 724 | 725 | // This might be a risk, for now it works 726 | DeleteFile(sfile); 727 | RenameFile(sfile, sfile2); 728 | 729 | return AUTOEXEC_CLEAN_SUCCESS; 730 | } 731 | 732 | 733 | 734 | 735 | 736 | 737 | /** 738 | * Returns how many times the given char occures in the given string. 739 | * 740 | * @param str String to search for in. 741 | * @return Occurences of the given char found in string. 742 | */ 743 | stock static int GetCharCountInStr(int character, const char[] str) 744 | { 745 | int len = strlen(str); 746 | int count; 747 | 748 | for (int i; i < len; i++) 749 | { 750 | if (str[i] == character) 751 | { 752 | count++; 753 | } 754 | } 755 | 756 | return count; 757 | } 758 | 759 | 760 | 761 | 762 | 763 | 764 | #pragma deprecated 765 | stock bool AutoExecConfig_CacheConvars() 766 | { 767 | return false; 768 | } 769 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------