1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski package com.sun.star.lib.util; 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski import java.io.File; 26*b1cdbd2cSJim Jagielski import java.net.URL; 27*b1cdbd2cSJim Jagielski import java.net.URLClassLoader; 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski /** Helper functions to locate and load native files. 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski The methods in this class are designed to find the requested resources in as 32*b1cdbd2cSJim Jagielski many cases as possible. They search various places, roughly from most 33*b1cdbd2cSJim Jagielski specific to most general. This works well if a component is known to bring 34*b1cdbd2cSJim Jagielski with it a certain resource, and that resource has to be found. However, it 35*b1cdbd2cSJim Jagielski might not work very well in cases where you want to check whether a 36*b1cdbd2cSJim Jagielski component brings with it a certain resource or not: a similarly named 37*b1cdbd2cSJim Jagielski resource from another component might be found by the eager search 38*b1cdbd2cSJim Jagielski algorithm. 39*b1cdbd2cSJim Jagielski */ 40*b1cdbd2cSJim Jagielski public final class NativeLibraryLoader { 41*b1cdbd2cSJim Jagielski /** Load a system library, using a given class loader to locate the library. 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski This is similar to System.loadLibrary. 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski @param loader a class loader; may be null 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @param libname the library name; how this name is mapped to a system 48*b1cdbd2cSJim Jagielski library name is system dependent 49*b1cdbd2cSJim Jagielski */ loadLibrary(ClassLoader loader, String libname)50*b1cdbd2cSJim Jagielski public static void loadLibrary(ClassLoader loader, String libname) { 51*b1cdbd2cSJim Jagielski String syslibname = System.mapLibraryName(libname); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski File path = getResource(loader, System.mapLibraryName(libname)); 54*b1cdbd2cSJim Jagielski if (path == null) { 55*b1cdbd2cSJim Jagielski // check special jni lib extension on Mac 56*b1cdbd2cSJim Jagielski if (syslibname.contains("dylib")) { 57*b1cdbd2cSJim Jagielski syslibname = syslibname.replace("dylib", "jnilib"); 58*b1cdbd2cSJim Jagielski } 59*b1cdbd2cSJim Jagielski path = getResource(loader, syslibname); 60*b1cdbd2cSJim Jagielski } 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski if (path == null) { 63*b1cdbd2cSJim Jagielski // If the library cannot be found as a class loader resource, try 64*b1cdbd2cSJim Jagielski // the global System.loadLibrary as a last resort: 65*b1cdbd2cSJim Jagielski System.loadLibrary(libname); 66*b1cdbd2cSJim Jagielski } else { 67*b1cdbd2cSJim Jagielski System.load(path.getAbsolutePath()); 68*b1cdbd2cSJim Jagielski } 69*b1cdbd2cSJim Jagielski } 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski /** Locate a system resource, using a given class loader. 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski This is similar to ClassLoader.getResource, but only works for local 74*b1cdbd2cSJim Jagielski resources (local files), and adds additional functionality for 75*b1cdbd2cSJim Jagielski URLClassLoaders. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @param loader a class loader; may be null 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @param name a resource name (that is, the name of a file) 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski @return a File locating the resource, or null if the resource was not 82*b1cdbd2cSJim Jagielski found 83*b1cdbd2cSJim Jagielski */ getResource(ClassLoader loader, String name)84*b1cdbd2cSJim Jagielski public static File getResource(ClassLoader loader, String name) { 85*b1cdbd2cSJim Jagielski if (loader != null) { 86*b1cdbd2cSJim Jagielski File path = UrlToFileMapper.mapUrlToFile(loader.getResource(name)); 87*b1cdbd2cSJim Jagielski if (path != null) { 88*b1cdbd2cSJim Jagielski return path; 89*b1cdbd2cSJim Jagielski } 90*b1cdbd2cSJim Jagielski } 91*b1cdbd2cSJim Jagielski // URLClassLoaders work on lists of URLs, which are typically URLs 92*b1cdbd2cSJim Jagielski // locating JAR files (scheme://auth/dir1/dir2/some.jar). The following 93*b1cdbd2cSJim Jagielski // code looks for resource name beside the JAR file 94*b1cdbd2cSJim Jagielski // (scheme://auth/dir1/dir2/name) and one directory up 95*b1cdbd2cSJim Jagielski // (scheme://auth/dir1/name). The second step is important in a typical 96*b1cdbd2cSJim Jagielski // OOo installation, where the JAR files are in the program/classes 97*b1cdbd2cSJim Jagielski // directory while the shared libraries are in the program directory. 98*b1cdbd2cSJim Jagielski if (loader instanceof URLClassLoader) { 99*b1cdbd2cSJim Jagielski URL[] urls = ((URLClassLoader) loader).getURLs(); 100*b1cdbd2cSJim Jagielski for (int i = 0; i < urls.length; ++i) { 101*b1cdbd2cSJim Jagielski File path = UrlToFileMapper.mapUrlToFile(urls[i]); 102*b1cdbd2cSJim Jagielski if (path != null) { 103*b1cdbd2cSJim Jagielski File dir = path.isDirectory() ? path : path.getParentFile(); 104*b1cdbd2cSJim Jagielski if (dir != null) { 105*b1cdbd2cSJim Jagielski path = new File(dir, name); 106*b1cdbd2cSJim Jagielski if (path.exists()) { 107*b1cdbd2cSJim Jagielski return path; 108*b1cdbd2cSJim Jagielski } 109*b1cdbd2cSJim Jagielski dir = dir.getParentFile(); 110*b1cdbd2cSJim Jagielski if (dir != null) { 111*b1cdbd2cSJim Jagielski path = new File(dir, name); 112*b1cdbd2cSJim Jagielski if (path.exists()) { 113*b1cdbd2cSJim Jagielski return path; 114*b1cdbd2cSJim Jagielski } 115*b1cdbd2cSJim Jagielski } 116*b1cdbd2cSJim Jagielski } 117*b1cdbd2cSJim Jagielski } 118*b1cdbd2cSJim Jagielski } 119*b1cdbd2cSJim Jagielski } 120*b1cdbd2cSJim Jagielski return null; 121*b1cdbd2cSJim Jagielski } 122*b1cdbd2cSJim Jagielski NativeLibraryLoader()123*b1cdbd2cSJim Jagielski private NativeLibraryLoader() {} // do not instantiate 124*b1cdbd2cSJim Jagielski } 125