8212048: Cleanup source code and fix issues discussed in preliminary review
Reviewed-by: almatvee
/*
* Copyright (c) 2014, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
#include "Platform.h"
#ifdef MAC
#include "MacPlatform.h"
#include "Helpers.h"
#include "Package.h"
#include "PropertyFile.h"
#include "IniFile.h"
#include <sys/sysctl.h>
#include <pthread.h>
#include <vector>
#import <Foundation/Foundation.h>
#import <AppKit/NSRunningApplication.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreFoundation/CFString.h>
#ifdef __OBJC__
#import <Cocoa/Cocoa.h>
#endif //__OBJC__
#define MAC_PACKAGER_TMP_DIR \
"/Library/Application Support/Oracle/Java/Packager/tmp"
NSString* StringToNSString(TString Value) {
NSString* result = [NSString stringWithCString:Value.c_str()
encoding:[NSString defaultCStringEncoding]];
return result;
}
MacPlatform::MacPlatform(void) : Platform(), GenericPlatform(), PosixPlatform() {
}
MacPlatform::~MacPlatform(void) {
}
bool MacPlatform::UsePListForConfigFile() {
return FilePath::FileExists(GetConfigFileName()) == false;
}
void MacPlatform::ShowMessage(TString Title, TString Description) {
NSString *ltitle = StringToNSString(Title);
NSString *ldescription = StringToNSString(Description);
NSLog(@"%@:%@", ltitle, ldescription);
}
void MacPlatform::ShowMessage(TString Description) {
TString appname = GetModuleFileName();
appname = FilePath::ExtractFileName(appname);
ShowMessage(appname, Description);
}
TString MacPlatform::getTmpDirString() {
return TString(MAC_PACKAGER_TMP_DIR);
}
void MacPlatform::reactivateAnotherInstance() {
if (singleInstanceProcessId == 0) {
printf("Unable to reactivate another instance, PID is undefined");
return;
}
NSRunningApplication* app =
[NSRunningApplication runningApplicationWithProcessIdentifier:
singleInstanceProcessId];
if (app != nil) {
[app activateWithOptions: NSApplicationActivateIgnoringOtherApps];
} else {
printf("Unable to reactivate another instance PID: %d",
singleInstanceProcessId);
}
}
TCHAR* MacPlatform::ConvertStringToFileSystemString(TCHAR* Source,
bool &release) {
TCHAR* result = NULL;
release = false;
CFStringRef StringRef = CFStringCreateWithCString(kCFAllocatorDefault,
Source, kCFStringEncodingUTF8);
if (StringRef != NULL) {
@try {
CFIndex length =
CFStringGetMaximumSizeOfFileSystemRepresentation(StringRef);
result = new char[length + 1];
if (result != NULL) {
if (CFStringGetFileSystemRepresentation(StringRef,
result, length)) {
release = true;
}
else {
delete[] result;
result = NULL;
}
}
}
@finally {
CFRelease(StringRef);
}
}
return result;
}
TCHAR* MacPlatform::ConvertFileSystemStringToString(TCHAR* Source,
bool &release) {
TCHAR* result = NULL;
release = false;
CFStringRef StringRef = CFStringCreateWithFileSystemRepresentation(
kCFAllocatorDefault, Source);
if (StringRef != NULL) {
@try {
CFIndex length = CFStringGetLength(StringRef);
if (length > 0) {
CFIndex maxSize = CFStringGetMaximumSizeForEncoding(
length, kCFStringEncodingUTF8);
result = new char[maxSize + 1];
if (result != NULL) {
if (CFStringGetCString(StringRef, result, maxSize,
kCFStringEncodingUTF8) == true) {
release = true;
}
else {
delete[] result;
result = NULL;
}
}
}
}
@finally {
CFRelease(StringRef);
}
}
return result;
}
void MacPlatform::SetCurrentDirectory(TString Value) {
chdir(PlatformString(Value).toPlatformString());
}
TString MacPlatform::GetPackageRootDirectory() {
NSBundle *mainBundle = [NSBundle mainBundle];
NSString *mainBundlePath = [mainBundle bundlePath];
NSString *contentsPath =
[mainBundlePath stringByAppendingString:@"/Contents"];
TString result = [contentsPath UTF8String];
return result;
}
TString MacPlatform::GetAppDataDirectory() {
TString result;
NSArray *paths = NSSearchPathForDirectoriesInDomains(
NSApplicationSupportDirectory, NSUserDomainMask, YES);
NSString *applicationSupportDirectory = [paths firstObject];
result = [applicationSupportDirectory UTF8String];
return result;
}
TString MacPlatform::GetBundledJVMLibraryFileName(TString RuntimePath) {
TString result;
// first try lib/, then lib/jli
result = FilePath::IncludeTrailingSeparator(RuntimePath) +
_T("Contents/Home/lib/libjli.dylib");
if (FilePath::FileExists(result) == false) {
result = FilePath::IncludeTrailingSeparator(RuntimePath) +
_T("Contents/Home/lib/jli/libjli.dylib");
if (FilePath::FileExists(result) == false) {
// cannot find
NSLog(@"Cannot find libjli.dysym!");
result = _T("");
}
}
return result;
}
TString MacPlatform::GetAppName() {
NSString *appName = [[NSProcessInfo processInfo] processName];
TString result = [appName UTF8String];
return result;
}
void AppendPListArrayToIniFile(NSDictionary *infoDictionary,
IniFile *result, TString Section) {
NSString *sectionKey =
[NSString stringWithUTF8String:PlatformString(Section).toMultibyte()];
NSDictionary *array = [infoDictionary objectForKey:sectionKey];
for (id option in array) {
if ([option isKindOfClass:[NSString class]]) {
TString arg = [option UTF8String];
TString name;
TString value;
if (Helpers::SplitOptionIntoNameValue(arg, name, value) == true) {
result->Append(Section, name, value);
}
}
}
}
void AppendPListDictionaryToIniFile(NSDictionary *infoDictionary,
IniFile *result, TString Section, bool FollowSection = true) {
NSDictionary *dictionary = NULL;
if (FollowSection == true) {
NSString *sectionKey = [NSString stringWithUTF8String:PlatformString(
Section).toMultibyte()];
dictionary = [infoDictionary objectForKey:sectionKey];
}
else {
dictionary = infoDictionary;
}
for (id key in dictionary) {
id option = [dictionary valueForKey:key];
if ([key isKindOfClass:[NSString class]] &&
[option isKindOfClass:[NSString class]]) {
TString name = [key UTF8String];
TString value = [option UTF8String];
result->Append(Section, name, value);
}
}
}
// Convert parts of the info.plist to the INI format the rest of the packager
// uses unless a packager config file exists.
ISectionalPropertyContainer* MacPlatform::GetConfigFile(TString FileName) {
IniFile* result = new IniFile();
if (UsePListForConfigFile() == false) {
if (result->LoadFromFile(FileName) == false) {
// New property file format was not found,
// attempt to load old property file format.
Helpers::LoadOldConfigFile(FileName, result);
}
}
else {
NSBundle *mainBundle = [NSBundle mainBundle];
NSDictionary *infoDictionary = [mainBundle infoDictionary];
std::map<TString, TString> keys = GetKeys();
// Packager options.
AppendPListDictionaryToIniFile(infoDictionary, result,
keys[CONFIG_SECTION_APPLICATION], false);
// jvmargs
AppendPListArrayToIniFile(infoDictionary, result,
keys[CONFIG_SECTION_JVMOPTIONS]);
// jvmuserargs
AppendPListDictionaryToIniFile(infoDictionary, result,
keys[CONFIG_SECTION_JVMUSEROPTIONS]);
// Generate AppCDS Cache
AppendPListDictionaryToIniFile(infoDictionary, result,
keys[CONFIG_SECTION_APPCDSJVMOPTIONS]);
AppendPListDictionaryToIniFile(infoDictionary, result,
keys[CONFIG_SECTION_APPCDSGENERATECACHEJVMOPTIONS]);
// args
AppendPListArrayToIniFile(infoDictionary, result,
keys[CONFIG_SECTION_ARGOPTIONS]);
}
return result;
}
TString GetModuleFileNameOSX() {
Dl_info module_info;
if (dladdr(reinterpret_cast<void*>(GetModuleFileNameOSX),
&module_info) == 0) {
// Failed to find the symbol we asked for.
return std::string();
}
return TString(module_info.dli_fname);
}
#include <mach-o/dyld.h>
TString MacPlatform::GetModuleFileName() {
//return GetModuleFileNameOSX();
TString result;
DynamicBuffer<TCHAR> buffer(MAX_PATH);
uint32_t size = buffer.GetSize();
if (_NSGetExecutablePath(buffer.GetData(), &size) == 0) {
result = FileSystemStringToString(buffer.GetData());
}
return result;
}
bool MacPlatform::IsMainThread() {
bool result = (pthread_main_np() == 1);
return result;
}
TPlatformNumber MacPlatform::GetMemorySize() {
unsigned long long memory = [[NSProcessInfo processInfo] physicalMemory];
// Convert from bytes to megabytes.
TPlatformNumber result = memory / 1048576;
return result;
}
std::map<TString, TString> MacPlatform::GetKeys() {
std::map<TString, TString> keys;
if (UsePListForConfigFile() == false) {
return GenericPlatform::GetKeys();
}
else {
keys.insert(std::map<TString, TString>::value_type(CONFIG_VERSION,
_T("app.version")));
keys.insert(std::map<TString, TString>::value_type(CONFIG_MAINJAR_KEY,
_T("JVMMainJarName")));
keys.insert(std::map<TString, TString>::value_type(CONFIG_MAINMODULE_KEY,
_T("JVMMainModuleName")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_MAINCLASSNAME_KEY, _T("JVMMainClassName")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_CLASSPATH_KEY, _T("JVMAppClasspath")));
keys.insert(std::map<TString, TString>::value_type(APP_NAME_KEY,
_T("CFBundleName")));
keys.insert(std::map<TString, TString>::value_type(CONFIG_APP_ID_KEY,
_T("JVMPreferencesID")));
keys.insert(std::map<TString, TString>::value_type(JVM_RUNTIME_KEY,
_T("JVMRuntime")));
keys.insert(std::map<TString, TString>::value_type(PACKAGER_APP_DATA_DIR,
_T("CFBundleIdentifier")));
keys.insert(std::map<TString, TString>::value_type(CONFIG_SPLASH_KEY,
_T("app.splash")));
keys.insert(std::map<TString, TString>::value_type(CONFIG_APP_MEMORY,
_T("app.memory")));
keys.insert(std::map<TString, TString>::value_type(CONFIG_APP_DEBUG,
_T("app.debug")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_APPLICATION_INSTANCE, _T("app.application.instance")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_SECTION_APPLICATION, _T("Application")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_SECTION_JVMOPTIONS, _T("JVMOptions")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_SECTION_JVMUSEROPTIONS, _T("JVMUserOptions")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_SECTION_JVMUSEROVERRIDESOPTIONS,
_T("JVMUserOverrideOptions")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_SECTION_APPCDSJVMOPTIONS, _T("AppCDSJVMOptions")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_SECTION_APPCDSGENERATECACHEJVMOPTIONS,
_T("AppCDSGenerateCacheJVMOptions")));
keys.insert(std::map<TString, TString>::value_type(
CONFIG_SECTION_ARGOPTIONS, _T("ArgOptions")));
}
return keys;
}
#ifdef DEBUG
bool MacPlatform::IsNativeDebuggerPresent() {
int state;
int mib[4];
struct kinfo_proc info;
size_t size;
info.kp_proc.p_flag = 0;
mib[0] = CTL_KERN;
mib[1] = KERN_PROC;
mib[2] = KERN_PROC_PID;
mib[3] = getpid();
size = sizeof(info);
state = sysctl(mib, sizeof(mib) / sizeof(*mib), &info, &size, NULL, 0);
assert(state == 0);
return ((info.kp_proc.p_flag & P_TRACED) != 0);
}
int MacPlatform::GetProcessID() {
int pid = [[NSProcessInfo processInfo] processIdentifier];
return pid;
}
#endif //DEBUG
class UserDefaults {
private:
OrderedMap<TString, TString> FData;
TString FDomainName;
bool ReadDictionary(NSDictionary *Items, OrderedMap<TString,
TString> &Data) {
bool result = false;
for (id key in Items) {
id option = [Items valueForKey:key];
if ([key isKindOfClass:[NSString class]] &&
[option isKindOfClass:[NSString class]]) {
TString name = [key UTF8String];
TString value = [option UTF8String];
if (name.empty() == false) {
Data.Append(name, value);
}
}
}
return result;
}
// Open and read the defaults file specified by domain.
bool ReadPreferences(NSDictionary *Defaults, std::list<TString> Keys,
OrderedMap<TString, TString> &Data) {
bool result = false;
if (Keys.size() > 0 && Defaults != NULL) {
NSDictionary *node = Defaults;
while (Keys.size() > 0 && node != NULL) {
TString key = Keys.front();
Keys.pop_front();
NSString *tempKey = StringToNSString(key);
node = [node valueForKey:tempKey];
if (Keys.size() == 0) {
break;
}
}
if (node != NULL) {
result = ReadDictionary(node, Data);
}
}
return result;
}
NSDictionary* LoadPreferences(TString DomainName) {
NSDictionary *result = NULL;
if (DomainName.empty() == false) {
NSUserDefaults *prefs = [[NSUserDefaults alloc] init];
if (prefs != NULL) {
NSString *lDomainName = StringToNSString(DomainName);
result = [prefs persistentDomainForName: lDomainName];
}
}
return result;
}
public:
UserDefaults(TString DomainName) {
FDomainName = DomainName;
}
bool Read(std::list<TString> Keys) {
NSDictionary *defaults = LoadPreferences(FDomainName);
return ReadPreferences(defaults, Keys, FData);
}
OrderedMap<TString, TString> GetData() {
return FData;
}
};
MacJavaUserPreferences::MacJavaUserPreferences(void) : JavaUserPreferences() {
}
TString toLowerCase(TString Value) {
// Use Cocoa's lowercase method because it is better than
// the ones provided by C/C++.
NSString *temp = StringToNSString(Value);
temp = [temp lowercaseString];
TString result = [temp UTF8String];
return result;
}
// Split the string Value into using Delimiter.
std::list<TString> Split(TString Value, TString Delimiter) {
std::list<TString> result;
std::vector<char> buffer(Value.c_str(), Value.c_str() + Value.size() + 1);
char *p = strtok(&buffer[0], Delimiter.data());
while (p != NULL) {
TString token = p;
result.push_back(token);
p = strtok(NULL, Delimiter.data());
}
return result;
}
// 1. If the path is fewer than three components (Example: one/two/three)
// then the domain is the
// default domain "com.apple.java.util.prefs" stored in the plist file
// ~/Library/Preferences/com.apple.java.util.prefs.plist
//
// For example: If AppID = "hello", the path is "hello/JVMUserOptions and the
// plist file is ~/Library/Preferences/com.apple.java.util.prefs.plist
// containing the contents:
//
// <?xml version="1.0" encoding="UTF-8"?>
// <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
// "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
// <plist version="1.0">
// <dict>
// <key>/</key>
// <dict>
// <key>hello/</key>
// <dict>
// <key>JVMUserOptions/</key>
// <dict>
// <key>-DXmx</key>
// <string>512m</string>
// </dict>
// </dict>
// </dict>
// </dict>
// </plist>
//
// 2. If the path is three or more, the first three become the domain name (even
// if shared across applicaitons) and the remaining become individual keys.
//
// For example: If AppID = "com/hello/foo", the path is
// "hello/JVMUserOptions and the
// domain is "com.hello.foo" stored in the plist file
// ~/Library/Preferences/com.hello.foo.plist
// containing the contents:
//
// <?xml version="1.0" encoding="UTF-8"?>
// <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
// "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
// <plist version="1.0">
// <dict>
// <key>/com/hello/foo/</key>
// <dict>
// <key>JVMUserOptions/</key>
// <dict>
// <key>-DXmx</key>
// <string>512m</string>
// </dict>
// </dict>
// </dict>
// </plist>
//
// NOTE: To change these values use the command line utility "defaults":
// Example: defaults read com.apple.java.util.prefs /
// Since OS 10.9 Mavericks the defaults are cashed so directly modifying
// the files is not recommended.
bool MacJavaUserPreferences::Load(TString Appid) {
bool result = false;
if (Appid.empty() == false) {
// This is for backwards compatability.
// Older packaged applications have an
// app.preferences.id that is delimited by period (".") rather than
// slash ("/") so convert to newer style.
TString path = Helpers::ReplaceString(Appid, _T("."), _T("/"));
path = path + _T("/JVMUserOptions");
TString domainName;
std::list<TString> keys = Split(path, _T("/"));
// If there are less than three parts to the path then use
// the default preferences file.
if (keys.size() < 3) {
domainName = _T("com.apple.java.util.prefs");
// Append slash to the end of each key.
for (std::list<TString>::iterator iterator = keys.begin();
iterator != keys.end(); iterator++) {
TString item = *iterator;
item = item + _T("/");
*iterator = item;
}
// The root key is /.
keys.push_front(_T("/"));
}
else {
// Remove the first three keys and use them for the
// root key and the preferencesID.
TString one = keys.front();
keys.pop_front();
TString two = keys.front();
keys.pop_front();
TString three = keys.front();
keys.pop_front();
domainName = one + TString(".") + two + TString(".") + three;
domainName = toLowerCase(domainName);
// Append slash to the end of each key.
for (std::list<TString>::iterator iterator = keys.begin();
iterator != keys.end(); iterator++) {
TString item = *iterator;
item = item + _T("/");
*iterator = item;
}
// The root key is /one/two/three/
TString key = TString("/") + one + TString("/") + two
+ TString("/") + three + TString("/");
keys.push_front(key);
}
UserDefaults userDefaults(domainName);
if (userDefaults.Read(keys) == true) {
result = true;
FMap = userDefaults.GetData();
}
}
return result;
}
#endif //MAC