Fix windows batch if instance.loc is missing - OPENDJ-1069

Fix for OPENDJ-132: upgrade utility does not accept relative path. Contribution from German Parente (thanks)

Fix for OPENDJ-222 : Renamed environment variables to OPENDJ_... Updated scripts so that if OPENDJ_JAVA_HOME and OPENDJ_JAVA_ARGS are not defined, we look at the legacy OPENDS_... ones.

Fix for issue #4554 - Potential problems using Windows Service during startup. The fix consists on waiting in the service code to the start-ds.bat call to finish (the re-entrant one). This avoids having a race condition problem locking the file (as can happen today). There is a new environment variable that can be configured (OPENDS_WINDOWS_SERVICE_STARTDS_WAIT). The default value is 300000 milliseconds (5 minutes). This is the maximum time in milliseconds the service code will wait for the server to start before checking directly its status. Also update setup.bat and uninstall.bat to return an error code when called in CLI mode.

fix for issue #3498 - stop-ds.bat doesn't work anymore if not launched from server root (OpenDS1.1.0) windows 'cd' cmd should be used with the '/d' modifier

These changes are separating the current delivery into an "Install Layout" (the binaries) and an "Instance Layout" (the user data).

Fix for issue 3438 (start-ds does not use configured jvm arguments when running as a windows service) Use the OPENDS_JAVA_ARGS environment variable when launching the java binary instead of OPENDS_SERVER_JAVA_ARGS.

Updated the copyright statement to reflect that Sun owns the full copyright on the project files.

2730: New - The setup command should perform some basic memory tuning Note: this issue is not fully covered by the proposed modifications but all that is missing in order to fix it is to figure out which are the default memory values that we want to propose in the setup. 2620: Server should be started as server JRE and clients should be started as client JREs The proposed solution goes beyond fixing the two issues and proposes a manner for the user to set specific java arguments (and use a specific JVM) for every command-line. Today the user can specify the JVM to be used using the OPENDS_JAVA_HOME environment variable and the java arguments by using the OPENDS_JAVA_ARGS environment variable. In the case of the JVM this covers most of the use cases (in general we will use the same JVM for all the command-lines). However this is quite limiting in the case of the java arguments we pass. For instance in general we want to run the server (start-ds command-line) using the server mode of the JVM but other command-lines using the -client mode of the JVM. In the same manner we might want to have a bigger heap when running the server than when we are running a "lightweight" utility as dsconfig. The proposed solution is to have a properties file called java.properties where the user specifies the different JVM and java arguments to be used for every command-line. Once the user has edited this properties file, (s)he must run a command-line called dsjavaproperties that will update all the scripts to use the arguments specified in that properties file. NOTE: there are a number of command-lines (import-ldif, export-ldif, backup, restore) where the user will be able to specify different java arguments (and different JVM) to use depending on whether the command-line is run in online or offline modes. You can see the comments on java.properties to get more information about this and in general about the different properties that can be set. The modification in the setup basically try to check if the JVM that is being used to run the setup (the one that will be used by default) supports the -client and -server options. Depending on the results of these checks the setup will update the java.properties file and then run dsjavaproperties to update the scripts.

Fix for issue 2035 (Use OpenDS specific environment variables to determine the JVM to be used.) Use two environment variables to know which is the JVM to be used by the scripts: OPENDS_JAVA_BIN and OPENDS_JAVA_HOME. When the setup creates the file lib/set-java-home it writes the contents of OPENDS_JAVA_HOME to it (instead of JAVA_HOME which was the previous behavior). Before these changes, the scripts used to look for JAVA_BIN, then JAVA_HOME and finally for the contents of the set-java-home file. The problem with this approach is that if the user required to specify JAVA_HOME or JAVA_BIN to an unsupported version of the JDK (because some other program in the machine had this requirement) the scripts of OpenDS could not run. Now the checks that we do to figure out the JVM are done in the following order: 1. Check if OPENDS_JAVA_BIN is defined in the environment. 2. Check if OPENDS_JAVA_HOME is defined in the environment. 3. Check if OPENDS_JAVA_HOME is defined in the lib/set-java-home file. 4. Check if JAVA_BIN is defined in the environment. 5. Check if JAVA_HOME is defined in the environment. 6. Check if we can figure out the java installation by executing "type java" (in UNIX environments). If any of the above checks is positive, we will try to use the JVM found. Extras: the uninstall script on UNIX now checks that we are using a JDK compatible with 1.5 and displays a user friendly message if it does not.

After some discussions it has been decided to merge the setup and uninstall commands so that we have the behavior that we had before. So with this changes, in order to work in CLI mode the option --cli must be specified.

Fix for issue 2224.i Do not use winlauncher for uninstall.bat as now it is a CLI only command.

The following modifications have the following goals: 1. Provide a fix for the GUI part of issue 1894 (consider replication in uninstall). Basically the graphical uninstall checks whether there is an ADS defined and if the server is configured for replication and asks the users whether (s)he wants to remove the references to the server that is being uninstalled. 2. Fix some minor issues that appear in the merged version of the installer and upgrader. 3. Update the build so that statuspanel.jar disappears. The idea is to minimize the number of jars that we have. This is a requirement coming from customers and approved by Neil in a conversation we had a while ago. 4. Minimize the number of classes that go to quicksetup.jar so that its size is the minimal possible and we reduce the download time when launching the WebStart based tools. This has been done by moving the uninstaller tool to OpenDS.jar (with the status tools).

Use work-around for long filename bug in Windows 2000. Issue #1985.

Back out changes made for issue #1985 due to apparent problems with windows 2000.

Fix for issue 1985. Use the short version of the path to call other scripts and to generate the CLASSPATH. This reduces the possibility of hitting the maximum environment variable size allowed on Windows.

Fix for issue 1603 (quickInstall fails to register service on vista) With the new user access control of Vista, even if we are administrators we are not allowed to do certain operations (such as writing in the service registry) in some circumstances. For instance if we launch net start <service_name> from a normal command prompt this will fail systematically. In order to be able to execute these "privileged" operations we have different alternatives: Execute the binary that will do the operations using the "Run as Administrator" option in Vista (or launching them from a command prompt that has been started using that same option). Add a manifest to the binary informing that the binary requires administrator privileges. The first alternative is one of the workarounds for the bug, however it does not apply to the case of the Java Web Start Installer. The second alternative is in what consists the bug fix. A new binary has been created. This binary has a manifest informing that it requires administrator privileges. This binary will be used in Vista as a wrapper to call operations that require administrator privileges (modifying the registry in windows-services.bat command line and calling "net start" and "net stop"). If the user is running the setup, the status-panel using the "Run as Administrator" option or is using the command lines from a command prompt launched with that option the behavior in Vista does not change with the behavior in previous versions of Windows. If the UAC is enabled and the user is not using the "Run as Administrator" options, (s)he will be prompted for confirmation each time the registry is modified and the server is started or stopped as a service. The wrapper is called on any of the individual operations. An alternative would be to call the wrapper when we launch the setup or the status-panel but this generates some issues: 1. This does not work (directly) with the Java Web Start installer. 2. This would force users that are not administrators to provide administrator credentials even to install/run an OpenDS that does not require to do privileged operations (an OpenDS that does not run as a service).

fix for issue #1865 (upgrade -V error) In case on -V option, BuildExtractor will exit with a pre-defined return code defined in QuickSetupCli.java (let's say 50). Script will test this specific return value to check if the non-null return code is an error. In case of none null return code, the upgradeLauncher will not be called.

Update a number of files to add the missing svn:eol-style property. Also, fix a couple of CDDL/copyright headers. Finally, update the CheckPrecommit Ant task so that it properly checks for a property that can be used to ignore these problems and continue with the build.

Allow classes directory to override classpath for Windows batch scripts

Use the first parameter of the batch file instead of the batch file itself to test whether we use the winlauncher.exe or not for the setup and the uninstall.

Fix for issue 1753. Instead of using %* to test if the user provided arguments in the command line just use the first argument with no quotes (%~0) to do the test. The fix applies both to the setup and the uninstall scripts on Windows.

Add the option -Xrs to java when we start the server as a service. This is required to avoid the server to be shutdown when is run as a service and the user logs off. Add some 'pause' commands when we could not get a proper JVM for the Windows batch files. This way when the user double clicks on them the command prompt window will stay open until they touch a key and (s)he will be able to read the error message.

Complete fix for 1252 restrict installed bin files to relevant platform. The bat files are only under 'bat' directory and some function scripts that are not targetted to be used by the user (_server-script, _client-script, etc.) have been moved now to lib.

Fix for issue 1273 (exception if JAVA_HOME undefined in scripts). The fix consists of modifying the scripts to launch the InstallDS classwith a test option using the JVM that was found. If the JVM can be successfully launched, the JVM is compatible with 1.5, if not we as sume that is not compatible with JDK 1.5. The downside of the fix is that it requires an additional start of the JVM each time the command line is launched. That is why the fix only applies to setup, uninstall, upgrade, start and stop command lines. The modifications in _server-script.* and _client-script.sh just modify the message displayed when a JVM could not be found (informing that JDK 1.5 or later can be used).

Fix for issue 1252 (restrict installed bin files to relevant platform). Create a new bat directory where we will place the batch files. Temporarily keep a copy of the batch files under the bin directory and add a README_WINDOWS.txt file under bin directory explaining that the files have been moved.

Fix for issue 1376. With the addition of AspectJ there are some added dependencies in the code. So for instance using the class StaticUtils requires je.jar to be on the path (which was not the case before). The uninstall scripts used to have a limited set of jar files so that afterwards there was a minimum number of files to be deleted. Instead of doing this uninstall scripts should use the full class path. In any case all the remaning files are under the same directory so the user will have to do the cleanup in the same single place as before.

Update all CDDL headers in source files to remove a typo.

Fix for Issues #1025 and #1248 ('stop-ds.bat should be able to stop server even if LDAP port' and 'cannot stop server through status panel'). The goal of these changes is to be able to have exactly the same user interface in Windows and Unix to stop the server. In windows we force the user to provide LDAP credentials even if the command is going to be run locally. The goal is to allow to stop the server using only system credentials (as we do in UNIX) when the user does not provide arguments when calling stop-ds.bat. In order to do this I have written some native code. This native code is called when we start the server to: 1. Launch the java process and get the associated PID. 2. Create a server.pid file as we do for UNIX systems to store the PID of the process. The native code that stops the server reads the PID file contents and tries to stop the process associated with the PID. In order to allow the users to be able to build the product with independence of the platform, the binaries will be included with the source code. The code used to generate these binaries will also be provided. I have generated 1 executable called winlauncher.exe. The binaries will be committed in the source tree under lib (with activation.jar and mail.jar). They will also be installed under <server root>\lib. The native code is in the files winlauncher.c and winlauncher.h. These files are placed under the new directory build-tools/src/windows. I have tried to keep the native code simple and leave as much logic as I could into the batch files (for instance everything related to the discovery of the java binaries) so that the administrators can play with them. A README file has been also been included to explain how to generate the binaries. Extras: When we call start-ds from the command line, the server will not stop when the command prompt window is closed (unless start-ds was called to run in not-detached mode). The next step is to register DS as a service to avoid the server to be stopped when the user logs out. When we call setup (with no arguments) or the statuspanel the generated process (and windows) will no longer get killed when the command prompt window is killed. When the user double-clicks on the setup.bat or the statuspanel.bat files, the command prompt window only appears briefly. Today when we do this a command prompt window stays open until we close setup or the status panel window.

The following modifications include the comments from Neil and Brian (thanks to both for your help): 1. Fix a bug with the setup script. Know this script is executable after the Web Start based installation. 2. Provide a different welcome message in the setup depending on whether we are launching the setup from the command line or Web Start. If we are launching the command line setup we make reference in the message to the Web Start installation and provide a link to the downloads page. 3. When the setup is successful, include in the message the path of the installation as was requested by William Hathaway. 4. Try to find a valid default port (of type []389) and not limit the search to 389. This implies not having any explanatory message to be displayed if we cannot connect to 389. 5. Update the code to better handle bug scenarii. Previously the code assumed that only RuntimeException could occur in case of a bug. This is not true in the general case, so know the code handles Throwable objects to detect bugs. 6. Provide the first implementation for the Uninstaller. Some code has been rearranged to maximize code re-use. The first implementation of the uninstaller basically does the following: - Display a confirmation message informing of what will happen with the installation files and the consequences of uninstalling the server. Ask the user which parts of the server must be uninstalled. Check if we have configuration references outside the installation path (for the moment this check is limited to database files and log files). If these references exist show them to the user and ask the user whether these 'external' files must be deteled or not. If the server is running we ask for confirmation to stop the server and if we are in windows we ask the user to provide a DN and a password to authenticate. If the user continues and the server is running the code calls stop-ds script, if the script succeeds the code tries to delete the files in the installation that the user wanted to uninstall and in the case there are external files to the installation path and the user wants to delete them delete also these external files. If everything works properly the uninstaller will delete all the files except the <install-root>/lib/quicksetup.jar and <install-root>/lib/OpenDS.jar file. OpenDS.jar file is required by the command line uninstaller to share some code. I preferred not to try to delete these files from the scripts as we cannot provide proper feedback (for instance localization) if we encounter a problem deleting these files. In both cases we inform the user that there are some files that must be deleted manually. 7. Provide the code to launch uninstall through command line that is analogous in terms of interaction to the graphical one. I have included two scripts to launch the uninstallation. The uninstall script for Unix is very similar to the setup script. However the uninstall.bat script has a difference with setup.bat. The difference is that I limit the class path to include only quicksetup.jar. This is done because I have not found a way to delete the jar files that are in the class path of the java application using pure java code, so as the uninstaller does only require OpenDS.jar and quicksetup.jar files I have chosen to minimize the jar files in the class path. This way the only files that are not deleted during installation is quicksetup.jar and OpenDS.jar. 8. Improve the wording of the install wizard as proposed by Brian and Neil. 9 . One minor tweak to the QuickSetup Welcome screen: make the reference to the "setup" command a monospace font to highlight it a bit more. 10. Fix for issue 1057 (stop-ds.bat and start-ds.bat do not work when called using Runtime.exec). The quicksetup code used to overwrite the environment variables when calling Runtime.exec which made the server not be able to start/stop correctly. 11. Fix some minor bugs with the default focus on some panels. 12. Update the setup scripts to use the java home file if the setup was previously called.