Added change for feature #1154254 Browser now has a sticky url.
[phpeclipse.git] / net.sourceforge.phpeclipse.ui / src / net / sourceforge / phpeclipse / ui / editor / BrowserUtil.java
1 package net.sourceforge.phpeclipse.ui.editor;
2
3 import java.net.MalformedURLException;
4 import java.net.URL;
5
6 import net.sourceforge.phpeclipse.ui.IPreferenceConstants;
7 import net.sourceforge.phpeclipse.ui.WebUI;
8 import net.sourceforge.phpeclipse.ui.internal.WebUIMessages;
9 import net.sourceforge.phpeclipse.ui.overlaypages.ProjectPrefUtil;
10 import net.sourceforge.phpeclipse.webbrowser.views.BrowserView;
11 import net.sourceforge.phpeclipse.webbrowser.views.ShowInContextBrowser;
12
13 import org.eclipse.core.resources.IFile;
14 import org.eclipse.core.runtime.IStatus;
15 import org.eclipse.core.runtime.Status;
16 import org.eclipse.jface.dialogs.ErrorDialog;
17 import org.eclipse.swt.widgets.Shell;
18 import org.eclipse.ui.IViewPart;
19 import org.eclipse.ui.IViewReference;
20 import org.eclipse.ui.IWorkbenchPage;
21 import org.eclipse.ui.IWorkbenchPart;
22 import org.eclipse.ui.PartInitException;
23 import org.eclipse.ui.PlatformUI;
24 import org.eclipse.ui.browser.IWebBrowser;
25 import org.eclipse.ui.browser.IWorkbenchBrowserSupport;
26 import org.eclipse.ui.internal.Perspective;
27 import org.eclipse.ui.internal.WorkbenchPage;
28 import org.eclipse.ui.part.IShowInTarget;
29 import org.eclipse.ui.part.ShowInContext;
30
31 public class BrowserUtil {
32
33         public static ShowInContextBrowser getShowInContext(IFile previewFile,
34                         boolean forceDBGPreview, String postFix) {
35                 String extension = previewFile.getFileExtension().toLowerCase();
36                 // boolean showHTMLFilesLocal = false;
37                 // boolean showXMLFilesLocal = false;
38                 boolean isHTMLFileName = false;
39                 boolean isXMLFileName = false;
40                 String localhostURL;
41                 if (!forceDBGPreview) {
42                         // showHTMLFilesLocal =
43                         // ProjectPrefUtil.getPreviewBooleanValue(previewFile,
44                         // IPreferenceConstants.PHP_SHOW_HTML_FILES_LOCAL);
45                         // showXMLFilesLocal =
46                         // ProjectPrefUtil.getPreviewBooleanValue(previewFile,
47                         // IPreferenceConstants.PHP_SHOW_XML_FILES_LOCAL);
48                         isHTMLFileName = "html".equals(extension)
49                                         || "htm".equals(extension) || "xhtml".equals(extension);
50                         isXMLFileName = "xml".equals(extension) || "xsd".equals(extension)
51                                         || "dtd".equals(extension);
52                 }
53                 // if (showHTMLFilesLocal && isHTMLFileName) {
54                 // localhostURL = previewFile.getLocation().toString();
55                 // } else if (showXMLFilesLocal && isXMLFileName) {
56                 // localhostURL = previewFile.getLocation().toString();
57                 // } else
58                 if ((localhostURL = ShowExternalPreviewAction.getLocalhostURL(null,
59                                 previewFile)) == null) {
60                         return new ShowInContextBrowser(previewFile, null, null);
61                 }
62                 localhostURL += postFix;
63                 return new ShowInContextBrowser(previewFile, null, localhostURL);
64         }
65
66         /**
67          * Returns the <code>IShowInTarget</code> for the given part, or
68          * <code>null</code> if it does not provide one.
69          * 
70          * @param targetPart
71          *            the target part
72          * @return the <code>IShowInTarget</code> or <code>null</code>
73          */
74         private static IShowInTarget getShowInTarget(IWorkbenchPart targetPart) {
75                 if (targetPart instanceof IShowInTarget) {
76                         return (IShowInTarget) targetPart;
77                 }
78                 Object o = targetPart.getAdapter(IShowInTarget.class);
79                 if (o instanceof IShowInTarget) {
80                         return (IShowInTarget) o;
81                 }
82                 return null;
83         }
84
85         public static void showPreview(IFile previewFile, boolean forceDBGPreview,
86                         String postFix) {
87                 if (previewFile == null) {
88                         // should never happen
89                         return;
90                 }
91                 IWorkbenchPage page = WebUI.getActivePage();
92                 if (page != null && page.isEditorAreaVisible()) {
93                         // String extension = previewFile.getFileExtension().toLowerCase();
94                         boolean autoPreview = forceDBGPreview;
95                         // boolean showHTMLFilesLocal = false;
96                         // boolean showXMLFilesLocal = false;
97                         // boolean isHTMLFileName = false;
98                         // boolean isXMLFileName = false;
99                         if (!forceDBGPreview) {
100                                 autoPreview = ProjectPrefUtil.getPreviewBooleanValue(
101                                                 previewFile,
102                                                 IPreferenceConstants.PHP_AUTO_PREVIEW_DEFAULT);
103
104                                 // showHTMLFilesLocal =
105                                 // ProjectPrefUtil.getPreviewBooleanValue(previewFile,
106                                 // IPreferenceConstants.PHP_SHOW_HTML_FILES_LOCAL);
107                                 // showXMLFilesLocal =
108                                 // ProjectPrefUtil.getPreviewBooleanValue(previewFile,
109                                 // IPreferenceConstants.PHP_SHOW_XML_FILES_LOCAL);
110                                 // isHTMLFileName = "html".equals(extension) ||
111                                 // "htm".equals(extension)
112                                 // || "xhtml".equals(extension);
113                                 // isXMLFileName = "xml".equals(extension) ||
114                                 // "xsd".equals(extension) ||
115                                 // "dtd".equals(extension);
116                         }
117                         if (autoPreview) {
118                                 // String localhostURL;
119                                 // if (showHTMLFilesLocal && isHTMLFileName) {
120                                 // localhostURL = previewFile.getLocation().toString();
121                                 // } else if (showXMLFilesLocal && isXMLFileName) {
122                                 // localhostURL = previewFile.getLocation().toString();
123                                 // } else if ((localhostURL =
124                                 // ShowExternalPreviewAction.getLocalhostURL(null, previewFile))
125                                 // ==
126                                 // null) {
127                                 // return;
128                                 // }
129                                 // localhostURL += postFix;
130                                 ShowInContext context = getShowInContext(previewFile,
131                                                 forceDBGPreview, postFix);
132                                 IWorkbenchPart sourcePart = page.getActivePart();
133                                 if (sourcePart == null && context != null) {
134                                         return;
135                                 }
136
137                                 // try {
138                                 Perspective persp = ((WorkbenchPage) page)
139                                                 .getActivePerspective();
140                                 if (persp != null) {
141
142                                         // If this view is already visible just return.
143                                         IViewReference ref = persp.findView(BrowserView.ID_BROWSER,
144                                                         null);
145                                         IViewPart view = null;
146                                         if (ref != null) {
147                                                 view = ref.getView(true);
148                                         }
149                                         if (view == null && forceDBGPreview) {
150                                                 try {
151                                                         view = persp.showView(BrowserView.ID_BROWSER, null);
152                                                         persp.bringToTop(persp.findView(
153                                                                         BrowserView.ID_BROWSER, null));
154                                                 } catch (PartInitException e) {
155                                                         WebUI.log(e);
156                                                 }
157                                         }
158                                         if (view != null) {
159                                                 IShowInTarget target = getShowInTarget(view);
160                                                 if (target != null && target.show(context)) {
161                                                         // success
162                                                 }
163                                                 ((WorkbenchPage) page)
164                                                                 .performedShowIn(BrowserView.ID_BROWSER);
165                                         }
166                                 }
167
168                                 // IViewPart view = page.showView(BrowserView.ID_BROWSER);
169                                 // IShowInTarget target = getShowInTarget(view);
170                                 // if (target != null && target.show(new
171                                 // ShowInContext(localhostURL,
172                                 // null))) {
173                                 // // success
174                                 // }
175                                 // ((WorkbenchPage)
176                                 // page).performedShowIn(BrowserView.ID_BROWSER); //
177                                 // TODO: move back up
178                                 // } catch (PartInitException e) {
179                                 // WorkbenchPlugin.log(
180                                 // "Error showing view in ShowInAction.run", e.getStatus());
181                                 // //$NON-NLS-1$
182                                 // }
183
184                                 // try {
185                                 // IViewPart part = page.showView(BrowserView.ID_BROWSER, null,
186                                 // IWorkbenchPage.VIEW_VISIBLE);
187                                 // if (part == null) {
188                                 // part = page.showView(BrowserView.ID_BROWSER);
189                                 // } else {
190                                 // page.bringToTop(part);
191                                 // }
192                                 // ((BrowserView) part).setUrl(localhostURL);
193                                 //
194                                 // } catch (Exception e) {
195                                 // // PHPeclipsePlugin.log(e);
196                                 // }
197                         }
198                 }
199         }
200
201         private static final String BROWSER_ID = "net.sourceforge.phpeclipse.browser";
202
203         /**
204          * convenient method to show browser as Editor
205          * 
206          */
207         public static void showBrowserAsEditor(IFile file, String queryString) {
208                 showBrowser(IWorkbenchBrowserSupport.AS_EDITOR, file, queryString);
209         }
210
211         /**
212          * convenient method to show browser as External Web Browser
213          * 
214          */
215         public static void showBrowserAsExternal(IFile file, String queryString) {
216                 showBrowser(IWorkbenchBrowserSupport.AS_EXTERNAL, file, queryString);
217         }
218
219         /**
220          * convenient method to show browser as View
221          * 
222          */
223         public static void showBrowserAsView(IFile file, String queryString) {
224                 showBrowser(IWorkbenchBrowserSupport.AS_VIEW, file, queryString);
225         }
226
227         /**
228          * Show browser according to General settings
229          * 
230          * See IWorkbenchBrowserSupport and DefaultWorkbenchBrowserSupport.
231          */
232         public static void showBrowser(int style, IFile file, String queryString) {
233                 ShowInContextBrowser context = getShowInContext(file, true, queryString);
234                 String url = context.getLocalhostUrl();
235                 if (url == null) {
236                         String dialogTitle = WebUIMessages
237                                         .getString("BrowserUtil.error.dialog.title");
238                         String message = WebUIMessages
239                                         .getString("BrowserUtil.null.url.message");
240                         String reason = WebUIMessages
241                                         .getString("BrowserUtil.null.url.reason");
242                         IStatus status = new Status(IStatus.ERROR, WebUI.PLUGIN_ID, 0,
243                                         reason, null);
244                         ErrorDialog.openError(new Shell(), dialogTitle, message, status);
245                         return;
246                 }
247                 String id = BROWSER_ID;
248                 switch (style) {
249                 case IWorkbenchBrowserSupport.AS_EXTERNAL:
250                         id += ".x";
251                         break;
252                 case IWorkbenchBrowserSupport.AS_EDITOR:
253                         id += ".e";
254                         break;
255                 case IWorkbenchBrowserSupport.AS_VIEW:
256                         id += ".v";
257                         break;
258                 }
259                 style |= IWorkbenchBrowserSupport.LOCATION_BAR
260                                 | IWorkbenchBrowserSupport.NAVIGATION_BAR
261                                 | IWorkbenchBrowserSupport.STATUS;
262                 try {
263                         IWebBrowser browser = PlatformUI.getWorkbench().getBrowserSupport()
264                                         .createBrowser(style, id, null, url);
265                         browser.openURL(new URL(url));
266
267                 } catch (PartInitException e) {
268                         WebUI.log(e);
269                 } catch (MalformedURLException e) {
270                         WebUI.log(e);
271                 }
272         }
273
274 }