replaced a lot of deprecated code; if someone runs into a commit conflict afterwards...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / util / PHPFileUtil.java
index 8073298..88e7f30 100644 (file)
  */
 package net.sourceforge.phpdt.internal.ui.util;
 
+import java.io.File;
+import java.util.List;
+import net.sourceforge.phpeclipse.PHPeclipsePlugin;
+import net.sourceforge.phpeclipse.ui.overlaypages.ProjectPrefUtil;
+
 import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.Path;
+import org.eclipse.ui.IEditorDescriptor;
+import org.eclipse.ui.IEditorRegistry;
+import org.eclipse.ui.IWorkbench;
+import org.eclipse.ui.PlatformUI;
 
-/**
- * @author khartlage
- *
- */
 public class PHPFileUtil {
-  public final static char[] SUFFIX_php = ".php".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_PHP = ".PHP".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_php3 = ".php3".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_PHP3 = ".PHP3".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_php4 = ".php4".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_PHP4 = ".PHP4".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_php5 = ".php5".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_PHP5 = ".PHP5".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_phtml = ".phtml".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_PHTML = ".PHTML".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_module = ".module".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_MODULE = ".MODULE".toCharArray(); //$NON-NLS-1$
-  
-  public final static char[] SUFFIX_inc = ".inc".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_INC = ".INC".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_html = ".html".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_HTML = ".HTML".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_tpl = ".tpl".toCharArray(); //$NON-NLS-1$
-  public final static char[] SUFFIX_TPL = ".TPL".toCharArray(); //$NON-NLS-1$
-
-  public  static boolean isPHPFile(IFile file) {
-    String extension = file.getFileExtension();
+//  private static String[] PHP_EXTENSIONS = null;
+
+  public final static String[] SMARTY_EXTENSIONS = { "tpl" };
+
+  public static boolean isPHPFile(IFile file) {
+//    String extension = file.getFileExtension();
     return isPHPFileName(file.getLocation().toString());
   }
 
+//  public final static String getFileExtension(String name) {
+//    int index = name.lastIndexOf('.');
+//    if (index == -1)
+//      return null;
+//    if (index == (name.length() - 1))
+//      return null; //$NON-NLS-1$
+//    return name.substring(index + 1);
+//  }
+
   /**
-   * Returns true iff str.toLowerCase().endsWith(".php")
-   * implementation is not creating extra strings.
+   * Returns true iff str.toLowerCase().endsWith(".php") implementation is not creating extra strings.
    */
   public final static boolean isPHPFileName(String name) {
-    return isPHP_FileName(name) || 
-           isPHP3_FileName(name) || 
-           isPHP4_FileName(name) ||  
-           isPHP5_FileName(name) ||
-           isModule_FileName(name) || 
-           isPHTML_FileName(name) || 
-           isINC_FileName(name);
+
+       //avoid handling a file without base name, e.g. ".php", which is a valid Eclipse resource name
+       File file=new File(name);
+       if (file.getName().startsWith(".")) {
+               return false;
+       }
+       IWorkbench workbench = PlatformUI.getWorkbench();
+       IEditorRegistry registry = workbench.getEditorRegistry();
+       IEditorDescriptor[] descriptors = registry.getEditors(name);
+
+       for (int i = 0; i < descriptors.length; i++) {
+                       if (descriptors[i].getId().equals(PHPeclipsePlugin.EDITOR_ID)) {
+                               return true;
+                       }
+               }
+//    String extension = getFileExtension(name);
+//    if (extension == null) {
+//      return false;
+//    }
+//    extension = extension.toLowerCase();
+//    PHP_EXTENSIONS = getExtensions();
+//    if (PHP_EXTENSIONS == null) {
+//      return false;
+//    }
+//    for (int i = 0; i < PHP_EXTENSIONS.length; i++) {
+//      if (extension.equals(PHP_EXTENSIONS[i])) {
+//        return true;
+//      }
+//    }
+    return false;
   }
-  
+
   /**
-   * Returns true iff str.toLowerCase().endsWith(".php")
-   * implementation is not creating extra strings.
+   * Returns true iff the file extension is a valid PHP Unit name implementation is not creating extra strings.
    */
-  private final static boolean isPHP_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_PHP.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_php[i] && c != SUFFIX_PHP[i])
-        return false;
-    }
-    return true;
+  public final static boolean isValidPHPUnitName(String filename) {
+    return PHPFileUtil.isPHPFileName(filename);
   }
 
   /**
-   * Returns true iff str.toLowerCase().endsWith(".php3")
-   * implementation is not creating extra strings.
+   * @return Returns the PHP extensions.
    */
-  private final static boolean isPHP3_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_PHP3.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_php3[i] && c != SUFFIX_PHP3[i])
-        return false;
-    }
-    return true;
-  }
+//  public static String[] getExtensions() {
+//    if (PHP_EXTENSIONS == null) {
+//      ArrayList list = new ArrayList();
+//      final IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore();
+//      String extensions = store.getString(PHPeclipsePlugin.PHP_EXTENSION_PREFS);
+//      extensions = extensions.trim();
+//      if (extensions.length() != 0) {
+//        StringTokenizer tokenizer = new StringTokenizer(extensions, " ,;:/-|");
+//        String token;
+//        while (tokenizer.hasMoreTokens()) {
+//          token = tokenizer.nextToken();
+//          if (token != null && token.length() >= 1) {
+//            list.add(token);
+//          }
+//        }
+//        if (list.size() != 0) {
+//          PHP_EXTENSIONS = new String[list.size()];
+//          for (int i = 0; i < list.size(); i++) {
+//            PHP_EXTENSIONS[i] = (String) list.get(i);
+//          }
+//        }
+//      }
+//    }
+//    return PHP_EXTENSIONS;
+//  }
 
   /**
-   * Returns true iff str.toLowerCase().endsWith(".php4")
-   * implementation is not creating extra strings.
+   * @param php_extensions
+   *          The PHP extensions to set.
    */
-  private final static boolean isPHP4_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_PHP4.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_php4[i] && c != SUFFIX_PHP4[i])
-        return false;
-    }
-    return true;
-  }
+//  public static void setExtensions(String[] php_extensions) {
+//    PHP_EXTENSIONS = php_extensions;
+//  }
 
   /**
-   * Returns true iff str.toLowerCase().endsWith(".php5")
-   * implementation is not creating extra strings.
+   * Creata the file for the given absolute file path
+   *
+   * @param absoluteFilePath
+   * @param project
+   * @return the file for the given absolute file path or <code>null</code> if no existing file can be found
    */
-  private final static boolean isPHP5_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_PHP5.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_php5[i] && c != SUFFIX_PHP5[i])
-        return false;
+  public static IFile createFile(IPath absoluteFilePath, IProject project) {
+    if (absoluteFilePath == null || project == null) {
+      return null;
     }
-    return true;
+
+    String projectPath = project.getLocation().toString();
+    String filePath = absoluteFilePath.toString().substring(projectPath.length() + 1);
+    return project.getFile(filePath);
+
   }
+
   /**
-   * Returns true iff str.toLowerCase().endsWith(".module")
-   * implementation is not creating extra strings.
+   * Determine the path of an include name string
+   *
+   * @param includeNameString
+   * @param resource
+   * @param project
+   * @return the path for the given include filename or <code>null</code> if no existing file can be found
    */
-  private final static boolean isModule_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_MODULE.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_module[i] && c != SUFFIX_MODULE[i])
-        return false;
+  public static IPath determineFilePath(String includeNameString, IResource resource, IProject project) {
+    IPath documentRootPath = ProjectPrefUtil.getDocumentRoot(project);
+    IPath resourcePath = resource.getProjectRelativePath();
+
+    File file = null;
+    IPath path = null;
+    path = documentRootPath.append(includeNameString);
+    file = path.toFile();
+    if (file.exists()) {
+      return path;
     }
-    return true;
-  }
- /**
-  * Returns true iff str.toLowerCase().endsWith(".phtml")
-  * implementation is not creating extra strings.
-  */
- private final static boolean isPHTML_FileName(String name) {
-   int nameLength = name == null ? 0 : name.length();
-   int suffixLength = SUFFIX_PHTML.length; 
-   if (nameLength < suffixLength)
-     return false;
-
-   for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-     char c = name.charAt(offset + i);
-     if (c != SUFFIX_phtml[i] && c != SUFFIX_PHTML[i])
-       return false;
-   }
-   return true;
- }
-  
-  /**
-   * Returns true iff str.toLowerCase().endsWith(".inc")
-   * implementation is not creating extra strings.
-   */
-  private final static boolean isINC_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_INC.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_inc[i] && c != SUFFIX_INC[i])
-        return false;
+
+    if (includeNameString.startsWith("../")) {
+      path = project.getLocation().append(resourcePath.removeLastSegments(1));
+      path = path.append(includeNameString);
+      file = path.toFile();
+      if (file.exists()) {
+        return path;
+      }
     }
-    return true;
-  }
-  
-  /**
-   * Returns true iff str.toLowerCase().endsWith(".html")
-   * implementation is not creating extra strings.
-   */
-  public final static boolean isHTML_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_HTML.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_html[i] && c != SUFFIX_HTML[i])
-        return false;
+
+    // includeNameString contains no path separator
+    path = project.getLocation().append(resourcePath.removeLastSegments(1));
+    path = path.append(includeNameString);
+    file = path.toFile();
+    if (file.exists()) {
+      return path;
     }
-    return true;
-  }
-  /**
-   * Returns true iff str.toLowerCase().endsWith(".tpl")
-   * implementation is not creating extra strings.
-   */
-  public final static boolean isTPL_FileName(String name) {
-    int nameLength = name == null ? 0 : name.length();
-    int suffixLength = SUFFIX_TPL.length;
-    if (nameLength < suffixLength)
-      return false;
-
-    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
-      char c = name.charAt(offset + i);
-      if (c != SUFFIX_tpl[i] && c != SUFFIX_TPL[i])
-        return false;
+    //    }
+
+    List includePaths = ProjectPrefUtil.getIncludePaths(project);
+    if (includePaths.size() > 0) {
+      for (int i = 0; i < includePaths.size(); i++) {
+        path = new Path(includePaths.get(i).toString()).append(includeNameString);
+        file = path.toFile();
+        if (file.exists()) {
+          return path;
+        }
+      }
     }
-    return true;
+    return null;
   }
-  
-  /**
-        * Returns true iff the file extension is a valid PHP Unit name
-        * implementation is not creating extra strings.
-        */
-       public final static boolean isValidPHPUnitName(String filename) {
-               return PHPFileUtil.isPHPFileName(filename) ||
-                      PHPFileUtil.isHTML_FileName(filename) ||
-                          PHPFileUtil.isTPL_FileName(filename);
-       }
-}
+}
\ No newline at end of file