/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2012 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*
* Contributor(s):
*
* Portions Copyrighted 2012 Sun Microsystems, Inc.
*/
package org.netbeans.modules.php.fuel.util;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.json.JSONArray;
import org.json.JSONException;
import org.netbeans.modules.php.api.editor.EditorSupport;
import org.netbeans.modules.php.api.editor.PhpClass;
import org.netbeans.modules.php.api.phpmodule.PhpModule;
import org.netbeans.modules.php.api.util.FileUtils;
import org.netbeans.modules.php.fuel.FuelPhpFrameworkProvider;
import org.netbeans.modules.php.fuel.preferences.FuelPhpPreferences;
import org.openide.awt.NotificationDisplayer;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.util.Exceptions;
import org.openide.util.ImageUtilities;
import org.openide.util.Lookup;
/**
*
* @author junichi11
*/
public final class FuelUtils {
public static final String ACTION_PREFIX = "action_"; // NOI18N
public static final String CONTROLLER_PREFIX = "Controller_"; // NOI18N
private static final String FUEL_APP_CLASSES_CONTROLLER_DIR = "%s/app/classes/controller"; // NOI18N
private static final String FUEL_APP_CLASSES_MODEL_DIR = "%s/app/classes/model"; // NOI18N
private static final String FUEL_APP_CLASSES_VIEW_DIR = "%s/app/classes/view"; // NOI18N
private static final String FUEL_APP_CLASSES_PRESENTER_DIR = "%s/app/classes/presenter"; // NOI18N
private static final String FUEL_APP_VIEWS_DIR = "%s/app/views"; // NOI18N
private static final String FUEL_APP_MODULES_DIR = "%s/app/modules"; // NOI18N
private static final String FUEL_AUTOCOMPLETION_PHP = "org-netbeans-modules-php-fuel/fuel_autocompletion.php"; // NOI18N
private static final String FUEL_AUTOCOMPLETION_TESTCASE_TXT = "org-netbeans-modules-php-fuel/fuel_autocompletion_testcase.txt"; // NOI18N
private static final String NBPROJECT_DIR_NAME = "nbproject"; // NOI18N
private static final String UTF8 = "UTF-8"; // NOI18N
private static final String CLASS_REGEX = "^(class |abstract class )((.+) extends .+|(.+) implements .+|(.+))$"; // NOI18N
private static final String FUEL_AUTOCOMPLETION = "fuel_autocompletion"; // NOI18N
private static final String PHP_EXT = "php"; // NOI18N
private static final String FUEL_AUTOCOMPLETION_WITH_EXT = FUEL_AUTOCOMPLETION + "." + PHP_EXT; // NOI18N
private static final String FUEL_ICON_16 = "org/netbeans/modules/php/fuel/resources/fuel_icon_16.png"; // NOI18N
private static final String SUCCESS_MSG = "Complete success : " + NBPROJECT_DIR_NAME + "/" + FUEL_AUTOCOMPLETION_WITH_EXT; // NOI18N
private static final String NOTIFY_TITLE = "Create auto completion file"; // NOI18N
private static final String FAIL_MSG = "Fail : Not Found fuel/core"; // NOI18N
private static final String PUBLIC_ASSETS_DIR = "public/assets"; // NOI18N
private static final String PUBLIC_ASSETS_JS_DIR = PUBLIC_ASSETS_DIR + "/js"; // NOI18N
private static final String PUBLIC_ASSETS_CSS_DIR = PUBLIC_ASSETS_DIR + "/css"; // NOI18N
private static final String PUBLIC_ASSETS_IMG_DIR = PUBLIC_ASSETS_DIR + "/img"; // NOI18N
public static JSONArray getJsonArray(URL url) throws IOException {
try {
BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), UTF8)); // NOI18N
StringBuilder contents = new StringBuilder();
String str;
while ((str = reader.readLine()) != null) {
contents.append(str);
}
JSONArray jsonArray = new JSONArray(contents.toString());
return jsonArray;
} catch (JSONException ex) {
Exceptions.printStackTrace(ex);
}
return null;
}
/**
* Get nbproject directory
*
* @param phpModule
* @return
*/
public static FileObject getNbproject(PhpModule phpModule) {
FileObject projectDirectory = phpModule.getProjectDirectory();
return projectDirectory.getFileObject(NBPROJECT_DIR_NAME);
}
/**
* Get project.properties.
*
* @param phpModule
* @return project.properties if file exists, false otherwise
*/
public static FileObject getProjectProperties(PhpModule phpModule) {
FileObject nbproject = getNbproject(phpModule);
return nbproject == null ? null : nbproject.getFileObject("project.properties"); // NOI18N
}
public static void getAutoCompletionFile(FileObject projectDirectory) {
if (projectDirectory == null) {
return;
}
FileObject nbprojectDirectory = projectDirectory.getFileObject(NBPROJECT_DIR_NAME);
FileObject autoCompletionFile = FileUtil.getConfigFile(FUEL_AUTOCOMPLETION_PHP);
if (nbprojectDirectory != null && autoCompletionFile != null) {
if (nbprojectDirectory.getFileObject(autoCompletionFile.getNameExt()) != null) {
// already exists
return;
}
try {
autoCompletionFile.copy(nbprojectDirectory, autoCompletionFile.getName(), autoCompletionFile.getExt());
} catch (IOException ex) {
Exceptions.printStackTrace(ex);
}
}
// XXX add log?
}
public static void createAutoCompletionFile(PhpModule phpModule, boolean useTestCaseMethod) throws Exception {
FileObject coreDirectory = getCoreDirectory(phpModule);
FileObject nbprojectDirectory = phpModule.getProjectDirectory().getFileObject(NBPROJECT_DIR_NAME);
if (nbprojectDirectory == null) {
// notification
NotificationDisplayer.getDefault().notify(NOTIFY_TITLE, ImageUtilities.loadImageIcon(FUEL_ICON_16, true), "Fail", null);
return;
}
FileObject completionFile = nbprojectDirectory.getFileObject(FUEL_AUTOCOMPLETION_WITH_EXT);
if (completionFile == null) {
completionFile = nbprojectDirectory.createData(FUEL_AUTOCOMPLETION, PHP_EXT);
}
if (coreDirectory != null) {
FileObject classesDirectory = coreDirectory.getFileObject("classes"); // NOI18N
FileObject[] children = classesDirectory.getChildren();
Arrays.sort(children, new FileObjectComparator());
PrintWriter printWriter = new PrintWriter(completionFile.getOutputStream());
printWriter.println("<?php"); // NOI18N
try {
writeAutoCompletionFile(printWriter, children, useTestCaseMethod);
} finally {
printWriter.close();
}
} else {
NotificationDisplayer.getDefault().notify(NOTIFY_TITLE, ImageUtilities.loadImageIcon(FUEL_ICON_16, true), FAIL_MSG, null);
return;
}
NotificationDisplayer.getDefault().notify(NOTIFY_TITLE, ImageUtilities.loadImageIcon(FUEL_ICON_16, true), SUCCESS_MSG, null);
}
/**
* Write auto completion file
*
* @param printWriter
* @param inputDirectories
* @throws IOException
*/
private static void writeAutoCompletionFile(PrintWriter printWriter, FileObject[] inputDirectories, boolean useTestMethod) throws IOException {
if (inputDirectories == null) {
return;
}
for (FileObject input : inputDirectories) {
if (input.isFolder()) {
FileObject[] children = input.getChildren();
Arrays.sort(children, new FileObjectComparator());
writeAutoCompletionFile(printWriter, input.getChildren(), useTestMethod);
} else {
List<String> lines = input.asLines();
for (String line : lines) {
if (line.startsWith("interface")) { // NOI18N
break;
}
Pattern pattern = Pattern.compile(CLASS_REGEX);
Matcher matcher = pattern.matcher(line);
if (matcher.find()) {
String className = "";
for (int i = 0; i < 3; i++) {
String match = matcher.group(3 + i);
if (match != null && !match.isEmpty()) {
className = matcher.group(3 + i);
}
}
String writeString = matcher.group(1) + className + " extends Fuel\\Core\\" + className + " {}";
if (useTestMethod && writeString.contains("TestCase")) { // NOI18N
writeTestCaseMethod(printWriter);
}
printWriter.println(writeString);
}
}
}
}
}
/**
* Write TestCase method. This is option.
*
* @param printWriter
*/
private static void writeTestCaseMethod(PrintWriter printWriter) throws IOException {
FileObject testCaseCompletionFile = FileUtil.getConfigFile(FUEL_AUTOCOMPLETION_TESTCASE_TXT);
for (String line : testCaseCompletionFile.asLines()) {
printWriter.println(line);
}
}
/**
* Get fuel directory
*
* @param phpModule
* @return
*/
public static FileObject getFuelDirectory(PhpModule phpModule) {
String fuelName = FuelPhpPreferences.getFuelName(phpModule);
FileObject sourceDirectory = phpModule.getSourceDirectory();
if (sourceDirectory == null) {
return null;
}
return sourceDirectory.getFileObject(fuelName);
}
/**
* get fuel core directory
*
* @param phpModule
* @return
*/
public static FileObject getCoreDirectory(PhpModule phpModule) {
String fuelName = FuelPhpPreferences.getFuelName(phpModule);
FileObject sourceDirectory = phpModule.getSourceDirectory();
if (sourceDirectory == null) {
return null;
}
return sourceDirectory.getFileObject(fuelName + "/core"); // NOI18N
}
/**
* Check controller file
*
* @param controller controller FileObject
* @return if prefix is "Controller_", return true.
*/
public static boolean isController(FileObject controller) {
if (controller == null) {
return false;
}
EditorSupport editorSupport = Lookup.getDefault().lookup(EditorSupport.class);
Collection<PhpClass> phpClasses = editorSupport.getClasses(controller);
if (phpClasses.size() != 1) {
return false;
}
PhpClass phpClass = null;
for (PhpClass pc : phpClasses) {
phpClass = pc;
}
if (phpClass == null) {
return false;
}
return phpClass.getName().startsWith(CONTROLLER_PREFIX);
}
/**
* Check view file
*
* @param view view FileObject
* @return if the view file is in views directory, return true.
*/
public static boolean isView(FileObject view) {
return isViewsViewModel(view, true);
}
/**
* Check view model file
*
* @param viewModel view model FileObject
* @return if the view model file is in view model directory, return true.
*/
public static boolean isViewModel(FileObject viewModel) {
return isViewsViewModel(viewModel, false);
}
/**
* Check presenter file
*
* @param presenter presenter FileObject
* @return if the presenter file is in view model directory, return true.
*/
public static boolean isPresenter(FileObject presenter) {
return isViewsViewModel(presenter, false);
}
private static boolean isViewsViewModel(FileObject fileObject, boolean isViews) {
if (fileObject == null || !FileUtils.isPhpFile(fileObject)) {
return false;
}
PhpModule phpModule = PhpModule.Factory.forFileObject(fileObject);
if (phpModule == null) {
phpModule = PhpModule.Factory.inferPhpModule();
}
if (phpModule == null) {
return false;
}
FileObject sourceDirectory = phpModule.getSourceDirectory();
if (sourceDirectory == null) {
return false;
}
String sourcePath = sourceDirectory.getPath();
String path = fileObject.getPath();
path = path.replace(sourcePath, ""); // NOI18N
if (isViews) {
return path.contains("/views/"); // NOI18N
}
return path.contains("/classes/view/") || path.contains("/classes/presenter/"); // NOI18N
}
/**
* Get views directory (fuel/app/views)
*
* @param fo FileObject
* @return views directory FileObject
*/
public static FileObject getViewsDirectory(FileObject fo) {
PhpModule pm = PhpModule.Factory.forFileObject(fo);
return getViewsDirectory(pm);
}
/**
* Get views directory (fuel/app/views)
*
* @param phpModule PhpModule
* @return views directory FileObject
*/
public static FileObject getViewsDirectory(PhpModule phpModule) {
return getDirectory(phpModule, FUEL_APP_VIEWS_DIR);
}
/**
* Get controller directory (fuel/app/classes/controller)
*
* @param fo FileObject
* @return controller directory FileObject
*/
public static FileObject getControllerDirectory(FileObject fo) {
PhpModule pm = PhpModule.Factory.forFileObject(fo);
return getControllerDirectory(pm);
}
/**
* Get controller directory (fuel/app/classes/controller)
*
* @param phpModule FileObject
* @return controller directory FileObject
*/
public static FileObject getControllerDirectory(PhpModule phpModule) {
return getDirectory(phpModule, FUEL_APP_CLASSES_CONTROLLER_DIR);
}
/**
* Get model directory (fuel/app/classes/model)
*
* @param phpModule FileObject
* @return model directory FileObject
*/
public static FileObject getModelDirectory(PhpModule phpModule) {
return getDirectory(phpModule, FUEL_APP_CLASSES_MODEL_DIR);
}
/**
* Get view model directory (fuel/app/classes/view)
*
* @param fo FileObject
* @return view model directory FileObject
*/
public static FileObject getViewModelDirectory(FileObject fo) {
PhpModule pm = PhpModule.Factory.forFileObject(fo);
return getViewModelDirectory(pm);
}
/**
* Get view model directory (fuel/app/classes/view)
*
* @param phpMoudle PhpModule
* @return view model directory FileObject
*/
public static FileObject getViewModelDirectory(PhpModule phpModule) {
return getDirectory(phpModule, FUEL_APP_CLASSES_VIEW_DIR);
}
/**
* Get presenter directory (fuel/app/classes/presenter)
*
* @param fo FileObject
* @return presenter directory FileObject
*/
public static FileObject getPresenterDirectory(FileObject fo) {
PhpModule pm = PhpModule.Factory.forFileObject(fo);
return getPresenterDirectory(pm);
}
/**
* Get view model directory (fuel/app/classes/presenter)
*
* @param phpMoudle PhpModule
* @return presenter directory FileObject
*/
public static FileObject getPresenterDirectory(PhpModule phpModule) {
return getDirectory(phpModule, FUEL_APP_CLASSES_PRESENTER_DIR);
}
/**
* Get modules directory (fuel/app/modules)
*
* @param phpMoudle PhpModule
* @return modules directory FileObject
*/
public static FileObject getModulesDirectory(PhpModule phpModule) {
return getDirectory(phpModule, FUEL_APP_MODULES_DIR);
}
/**
* Get assets directory (public/assets).
*
* @param phpModule
* @return
*/
public static FileObject getAssetsDirectory(PhpModule phpModule) {
return getDirectory(phpModule, PUBLIC_ASSETS_DIR);
}
/**
* Get assets js directory (public/assets/js).
*
* @param phpModule
* @return
*/
public static FileObject getAssetsJsDirectory(PhpModule phpModule) {
return getDirectory(phpModule, PUBLIC_ASSETS_JS_DIR);
}
/**
* Get assets css directory (public/assets/css).
*
* @param phpModule
* @return
*/
public static FileObject getAssetsCssDirectory(PhpModule phpModule) {
return getDirectory(phpModule, PUBLIC_ASSETS_CSS_DIR);
}
/**
* Get assets img directory (public/assets/img).
*
* @param phpModule
* @return
*/
public static FileObject getAssetsImgDirectory(PhpModule phpModule) {
return getDirectory(phpModule, PUBLIC_ASSETS_IMG_DIR);
}
/**
* Get directory
*
* @param phpModule
* @param directoryPath
* @return
*/
public static FileObject getDirectory(PhpModule phpModule, String directoryPath) {
if (phpModule == null) {
return null;
}
String path = String.format(directoryPath, FuelPhpPreferences.getFuelName(phpModule));
FileObject sourceDirectory = phpModule.getSourceDirectory();
if (sourceDirectory == null) {
return null;
}
return sourceDirectory.getFileObject(path);
}
/**
* Check action name
*
* @param name action name
* @return name starts with "action_", then return true.
*/
public static boolean isActionName(String name) {
return name.startsWith(ACTION_PREFIX) && !name.equals(ACTION_PREFIX);
}
/**
* Get infered controller
*
* @param view view file
* @return controller FileObject
*/
public static FileObject getInferedController(FileObject view) {
boolean isView = isView(view);
boolean isViewModel = isViewModel(view);
boolean isPresenter = isPresenter(view);
if (!isView && !isViewModel && !isPresenter) {
return null;
}
// view file path from views directory
String viewPath = getViewPath(view);
String controllerPath = viewPath.replace("/" + view.getNameExt(), "") + ".php"; // NOI18N
// get controller
StringBuilder sb = new StringBuilder();
int start = 0;
while (start != -1) {
start++;
start = viewPath.indexOf("/", start); // NOI18N
if (start == -1) {
break;
}
sb.append("../"); // NOI18N
}
if (isView) {
sb.append("../../"); // NOI18N
} else {
sb.append("../../../"); // NOI18N
}
sb.append("classes/controller/"); // NOI18N
sb.append(controllerPath);
FileObject controller = view.getFileObject(sb.toString());
if (!isController(controller)) {
return null;
}
return controller;
}
/**
* Get view file path from views / view model directory
*
* @param view
* @return view file relative path. contain extension.
*/
private static String getViewPath(FileObject view) {
PhpModule phpModule = PhpModule.Factory.forFileObject(view);
if (phpModule == null) {
phpModule = PhpModule.Factory.inferPhpModule();
}
if (phpModule == null) {
return null;
}
FileObject sourceDirectory = phpModule.getSourceDirectory();
if (sourceDirectory == null) {
return null;
}
String sourcePath = sourceDirectory.getPath();
String viewPath = view.getPath();
viewPath = viewPath.replace(sourcePath, ""); // NOI18N
if (isView(view)) {
viewPath = viewPath.replaceAll(".+/views/", ""); // NOI18N
} else if (isViewModel(view)) {
viewPath = viewPath.replaceAll(".+/view/", ""); // NOI18N
} else if (isPresenter(view)) {
viewPath = viewPath.replaceAll(".+/presenter/", ""); // NOI18N
} else {
return null;
}
return viewPath;
}
/**
* Get infered controller action name
*
* @param view view FileObject
* @return action name.
*/
public static String getInferedActionName(FileObject view) {
if (!isView(view) && !isViewModel(view) && !isPresenter(view)) {
return null;
}
return ACTION_PREFIX + view.getName();
}
/**
* Check whether FuelPHP
*
* @param phpMoudle
* @return true if in fuelphp module, otherwise false.
*/
public static boolean isFuelPHP(PhpModule phpModule) {
if (phpModule == null) {
return false;
}
return FuelPhpFrameworkProvider.getInstance().isInPhpModule(phpModule);
}
private static class FileObjectComparator implements Comparator<FileObject> {
@Override
public int compare(FileObject o1, FileObject o2) {
if (o1.isFolder() && o2.isData()) {
return -1;
}
if (o1.isData() && o2.isFolder()) {
return 1;
}
if ((o1.isFolder() && o2.isFolder())
|| (o1.isData() && o2.isData())) {
List<String> list = new ArrayList<>();
String name1 = o1.getName();
String name2 = o2.getName();
list.add(name1);
list.add(name2);
Collections.sort(list);
if (name1.equals(list.get(0))) {
return -1;
} else {
return 1;
}
}
return 0;
}
}
/**
* Check whether file is in modules.
*
* @param fileObject target FileObject
* @return true if file exists modules directory, otherwise false.
*/
public static boolean isInModules(FileObject fileObject) {
if (fileObject == null) {
return false;
}
PhpModule phpModule = PhpModule.Factory.forFileObject(fileObject);
if (phpModule == null) {
phpModule = PhpModule.Factory.inferPhpModule();
}
if (phpModule == null) {
return false;
}
FileObject sourceDirectory = phpModule.getSourceDirectory();
if (sourceDirectory == null) {
return false;
}
String sourcePath = sourceDirectory.getPath();
String path = fileObject.getPath();
path = path.replace(sourcePath, "");
return path.contains("/modules/"); // NOI18N
}
/**
* Get module directory name. e.g.
* fuel/app/modules/sample/app/classes/controller/welcome.php -> sample
*
* @param fileObject target FileObject
* @return module directory name.
*/
public static String getModuleName(FileObject fileObject) {
if (!isInModules(fileObject)) {
return null;
}
String path = fileObject.getPath();
path = path.replaceAll(".+/modules/", ""); // NOI18N
return path.substring(0, path.indexOf("/")); // NOI18N
}
/**
* Get module directory.
*
* @param phpModule
* @param name directory name
* @return module directory
*/
public static FileObject getModuleDirectory(PhpModule phpModule, String name) {
return getDirectory(phpModule, FUEL_APP_MODULES_DIR + "/" + name); // NOI18N
}
/**
* Separate path with ::.
*
* @param path
* @return
*/
public static String[] moduleSplit(String path) {
if (path == null) {
return null;
}
return path.split("::"); // NOI18N
}
/**
* Sort files.
*
* @param files
* @param desc true if order by desc, false if asc.
*/
public static void sortFileObject(FileObject[] files, final boolean desc) {
Arrays.sort(files, new ComparatorImpl(desc));
}
/**
* Sort files order by asc.
*
* @param files
*/
public static void sortFileObject(FileObject[] files) {
sortFileObject(files, false);
}
/**
* Sort files.
*
* @param files
* @param desc
*/
public static void sortFileObject(List<FileObject> files, final boolean desc) {
Collections.sort(files, new ComparatorImpl(desc));
}
/**
* Sort files order by asc.
*
* @param files
*/
public static void sortFileObject(List<FileObject> files) {
sortFileObject(files, false);
}
private static class ComparatorImpl implements Comparator<FileObject> {
private final boolean desc;
public ComparatorImpl(boolean desc) {
this.desc = desc;
}
@Override
public int compare(FileObject o1, FileObject o2) {
if (desc) {
return o2.getName().compareToIgnoreCase(o1.getName());
}
return o1.getName().compareToIgnoreCase(o2.getName());
}
}
}