From c97147b673ee545a3631082ad0d16a6adc549189 Mon Sep 17 00:00:00 2001
From: Luc Bourlier <luc.bourlier@typesafe.com>
Date: Fri, 1 Mar 2013 17:50:31 +0100
Subject: [PATCH] Adds a preference and an project preference page

The preference is initialized with framework defaults (play.api.templates._, play.api.templates.PlayMagic._).
It can be overriden at the project level, in the project properties.
Changes are not applied directly, as we are currently lacking a real builder.

Fix #35.
---
 org.scala-ide.play2/plugin.xml                | 43 ++++++++++
 .../src/org/scalaide/play2/PlayPlugin.scala   |  4 +-
 .../src/org/scalaide/play2/PlayProject.scala  |  8 ++
 .../play2/properties/PlayPreferences.scala    | 35 ++++++++
 .../properties/PreferenceInitializer.scala    | 12 +++
 .../properties/ProjectPropertyPage.scala      | 83 +++++++++++++++++++
 .../compiler/CompilerUsing.scala              | 16 ++--
 .../play2/util/Play2PropertyTester.scala      | 36 ++++++++
 .../util/SyncedScopedPreferenceStore.scala    | 16 ++++
 9 files changed, 241 insertions(+), 12 deletions(-)
 create mode 100644 org.scala-ide.play2/src/org/scalaide/play2/properties/PreferenceInitializer.scala
 create mode 100644 org.scala-ide.play2/src/org/scalaide/play2/properties/ProjectPropertyPage.scala
 create mode 100644 org.scala-ide.play2/src/org/scalaide/play2/util/Play2PropertyTester.scala
 create mode 100644 org.scala-ide.play2/src/org/scalaide/play2/util/SyncedScopedPreferenceStore.scala

diff --git a/org.scala-ide.play2/plugin.xml b/org.scala-ide.play2/plugin.xml
index 4c29880b..727d0ff7 100644
--- a/org.scala-ide.play2/plugin.xml
+++ b/org.scala-ide.play2/plugin.xml
@@ -71,6 +71,9 @@
       <initializer
             class="org.scalaide.play2.templateeditor.properties.TemplateColourPreferenceInitializer">
       </initializer>
+      <initializer
+            class="org.scalaide.play2.properties.PreferenceInitializer">
+      </initializer>
    </extension>
    <extension
          point="org.eclipse.core.contenttype.contentTypes">
@@ -138,6 +141,46 @@
             name="Format">
       </command>
    </extension>
+   <extension
+         point="org.eclipse.core.expressions.propertyTesters">
+      <propertyTester
+            class="org.scalaide.play2.util.Play2PropertyTester"
+            id="org.scala-ide.play2.isJavaPlayProject"
+            namespace="org.scala-ide.play2.properties"
+            properties="isPlay2Project"
+            type="org.eclipse.jdt.core.IJavaProject">
+      </propertyTester>
+      <propertyTester
+            class="org.scalaide.play2.util.Play2PropertyTester"
+            id="org.scala-ide.play2.isPlayProject"
+            namespace="org.scala-ide.play2.properties"
+            properties="isPlay2Project"
+            type="org.eclipse.core.resources.IProject">
+      </propertyTester>
+   </extension>
+   <extension
+         point="org.eclipse.ui.propertyPages">
+      <page
+            class="org.scalaide.play2.properties.ProjectPropertyPage"
+            id="org.scala-ide.play2.projectPropertyPage"
+            name="Play2">
+         <enabledWhen>
+            <and>
+               <or>
+	               <instanceof
+	                     value="org.eclipse.jdt.core.IJavaProject">
+	               </instanceof>
+	               <instanceof
+	                     value="org.eclipse.core.resources.IProject">
+	               </instanceof>
+               </or>
+               <test
+                     property="org.scala-ide.play2.properties.isPlay2Project">
+               </test>
+            </and>
+         </enabledWhen>
+      </page>
+   </extension>
    <!--
    <extension
          point="org.eclipse.ui.editors.markerAnnotationSpecification">
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/PlayPlugin.scala b/org.scala-ide.play2/src/org/scalaide/play2/PlayPlugin.scala
index 101840f7..26be3588 100644
--- a/org.scala-ide.play2/src/org/scalaide/play2/PlayPlugin.scala
+++ b/org.scala-ide.play2/src/org/scalaide/play2/PlayPlugin.scala
@@ -10,7 +10,7 @@ import org.eclipse.core.runtime.Status
 object PlayPlugin {
   @volatile var plugin: PlayPlugin = _
 
-  private final val PluginId = "org.scala-ide.play2"
+  final val PluginId = "org.scala-ide.play2"
   final val RouteFormatterMarginId = PluginId + ".routeeditor.margin"
   final val TemplateExtension = "scala.html"
 
@@ -50,4 +50,4 @@ class PlayPlugin extends AbstractUIPlugin {
       playProject <- asPlayProject(iProject)
     } playProject.initialize()
   }
-}
\ No newline at end of file
+}
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/PlayProject.scala b/org.scala-ide.play2/src/org/scalaide/play2/PlayProject.scala
index 6bfbc634..d76be280 100644
--- a/org.scala-ide.play2/src/org/scalaide/play2/PlayProject.scala
+++ b/org.scala-ide.play2/src/org/scalaide/play2/PlayProject.scala
@@ -8,10 +8,18 @@ import org.eclipse.core.resources.IFile
 import org.scalaide.play2.templateeditor.TemplateCompilationUnit
 import org.scalaide.play2.templateeditor.compiler.TemplatePresentationCompiler
 import org.scalaide.play2.util.AutoHashMap
+import org.eclipse.ui.preferences.ScopedPreferenceStore
+import org.eclipse.core.resources.ProjectScope
+import org.scalaide.play2.util.SyncedScopedPreferenceStore
+import org.eclipse.jface.preference.IPreferenceStore
 
 class PlayProject private (val scalaProject: ScalaProject) {
   private val presentationCompiler = new TemplatePresentationCompiler(this)
 
+  val cachedPreferenceStore = new SyncedScopedPreferenceStore(scalaProject.underlying, PlayPlugin.PluginId)
+
+  def generateScopedPreferenceStore: IPreferenceStore = new ScopedPreferenceStore(new ProjectScope(scalaProject.underlying), PlayPlugin.PluginId)
+
   def withPresentationCompiler[T](op: TemplatePresentationCompiler => T): T = {
     op(presentationCompiler)
   }
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/properties/PlayPreferences.scala b/org.scala-ide.play2/src/org/scalaide/play2/properties/PlayPreferences.scala
index 82a59664..ba8371f4 100644
--- a/org.scala-ide.play2/src/org/scalaide/play2/properties/PlayPreferences.scala
+++ b/org.scala-ide.play2/src/org/scalaide/play2/properties/PlayPreferences.scala
@@ -16,6 +16,41 @@ import org.eclipse.ui.IWorkbenchPreferencePage
 import org.eclipse.ui.dialogs.PropertyPage
 import org.scalaide.play2.PlayPlugin
 
+object PlayPreferences {
+
+  /** Preference containing the list of import to automatically add to the generate template code.
+   *  The data is stored as the string which will be added to the generated source (to not recreate
+   *  it everytime). The empty String represent an empty import list.
+   *  [[org.scalaide.play2.properties.PlayPreferences.serializeImports]] and [[org.scalaide.play2.properties.PlayPreferences.deserializeImports]]
+   *  need to be used when converting the preference value to/from Array[String].
+   */
+  final val TemplateImports = "templateImports"
+
+  // Regex used for the operations on the templateImports preference.
+  private val importsRegex = "import ([^\n]+)\n".r
+
+  /** @see [[org.scalaide.play2.properties.PlayPreferences.TemplateImports]]
+   */
+  def serializeImports(entries: Array[String]): String = {
+    if (entries.length == 0) {
+      ""
+    } else {
+      entries.mkString("import ", "\nimport ", "\n")
+    }
+  }
+
+  /** @see [[org.scalaide.play2.properties.PlayPreferences.TemplateImports]]
+   */
+  def deserializeImports(s: String): Array[String] = {
+    if (s.length == 0) {
+      new Array(0)
+    } else {
+      importsRegex.findAllIn(s).matchData.map(m => m.group(1)).toArray
+    }
+  }
+
+}
+
 class PlayPreferences extends PropertyPage with IWorkbenchPreferencePage with EclipseSettings
   with ScalaPluginPreferencePage with HasLogger {
 
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/properties/PreferenceInitializer.scala b/org.scala-ide.play2/src/org/scalaide/play2/properties/PreferenceInitializer.scala
new file mode 100644
index 00000000..8b4be6a5
--- /dev/null
+++ b/org.scala-ide.play2/src/org/scalaide/play2/properties/PreferenceInitializer.scala
@@ -0,0 +1,12 @@
+package org.scalaide.play2.properties
+
+import org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer
+import org.scalaide.play2.PlayPlugin
+
+class PreferenceInitializer extends AbstractPreferenceInitializer {
+
+  override def initializeDefaultPreferences() {
+    PlayPlugin.prefStore.setDefault(PlayPreferences.TemplateImports, "import play.api.templates._\nimport play.api.templates.PlayMagic._\n")
+  }
+
+}
\ No newline at end of file
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/properties/ProjectPropertyPage.scala b/org.scala-ide.play2/src/org/scalaide/play2/properties/ProjectPropertyPage.scala
new file mode 100644
index 00000000..a1455022
--- /dev/null
+++ b/org.scala-ide.play2/src/org/scalaide/play2/properties/ProjectPropertyPage.scala
@@ -0,0 +1,83 @@
+package org.scalaide.play2.properties
+
+import org.eclipse.core.resources.IProject
+import org.eclipse.core.runtime.IAdaptable
+import org.eclipse.jdt.core.IJavaProject
+import org.eclipse.jface.dialogs.IInputValidator
+import org.eclipse.jface.dialogs.InputDialog
+import org.eclipse.jface.preference.FieldEditorPreferencePage
+import org.eclipse.jface.preference.IPreferenceStore
+import org.eclipse.jface.preference.ListEditor
+import org.eclipse.jface.window.Window
+import org.eclipse.swt.widgets.Composite
+import org.eclipse.swt.widgets.Display
+import org.eclipse.ui.IWorkbenchPropertyPage
+import org.scalaide.play2.PlayPlugin
+
+/** Preference page displayed in the property dialog of (play) projects.
+ *  Used from the UI thread.
+ */
+class ProjectPropertyPage extends FieldEditorPreferencePage(FieldEditorPreferencePage.GRID) with IWorkbenchPropertyPage {
+
+  /** Preference field to display the list of extra imports.
+   */
+  private class ImportsFieldEditor(name: String, labelText: String, parent: Composite) extends ListEditor(name, labelText, parent) {
+
+    override protected def createList(entries: Array[String]): String =
+      PlayPreferences.serializeImports(entries)
+
+    override protected def parseString(s: String): Array[String] =
+      PlayPreferences.deserializeImports(s)
+
+    override protected def getNewInputObject(): String = {
+
+      val dlg = new InputDialog(
+        Display.getCurrent().getActiveShell(),
+        "Play template import",
+        "Enter an import value:",
+        "com.example._",
+        new IInputValidator {
+          def isValid(text: String) = null
+        });
+
+      if (dlg.open() == Window.OK) {
+        dlg.getValue()
+      } else {
+        null
+      }
+    }
+
+  }
+
+  // The preference store being edited.
+  // The data require to get the store is provided by the workbench during the page lifecycle.
+  private var prefStore: IPreferenceStore = _
+
+  // Members declared in org.eclipse.jface.preference.FieldEditorPreferencePage
+
+  override def createFieldEditors() {
+    addField(new ImportsFieldEditor(PlayPreferences.TemplateImports, "Template default imports", getFieldEditorParent()))
+  }
+
+  // Members declared in org.eclipse.ui.IWorkbenchPropertyPage
+
+  // doesn't seem to be a real function for this method.
+  // It looks like it leaked from the implementation of PropertyPage.
+  override def getElement(): IAdaptable = null
+
+  override def setElement(element: IAdaptable) {
+    prefStore = element match {
+      case project: IProject =>
+        PlayPlugin.plugin.asPlayProject(project).get.generateScopedPreferenceStore
+      case project: IJavaProject =>
+        PlayPlugin.plugin.asPlayProject(project.getProject()).get.generateScopedPreferenceStore
+    }
+  }
+
+  // ----
+
+  override def doGetPreferenceStore(): IPreferenceStore = {
+    prefStore
+  }
+
+}
\ No newline at end of file
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/templateeditor/compiler/CompilerUsing.scala b/org.scala-ide.play2/src/org/scalaide/play2/templateeditor/compiler/CompilerUsing.scala
index 0d4638a8..4efe3447 100644
--- a/org.scala-ide.play2/src/org/scalaide/play2/templateeditor/compiler/CompilerUsing.scala
+++ b/org.scala-ide.play2/src/org/scalaide/play2/templateeditor/compiler/CompilerUsing.scala
@@ -9,25 +9,21 @@ import play.templates.ScalaTemplateCompiler
 import play.templates.ScalaTemplateCompiler._
 import play.templates.TemplateCompilationError
 import scalax.file.Path
+import org.scalaide.play2.properties.PlayPreferences
 import scala.tools.eclipse.logging.HasLogger
-
 /**
  * a helper for using template compiler
  */
 object CompilerUsing extends HasLogger {
   val templateCompiler = ScalaTemplateCompiler
-  val additionalImports = """import play.templates._
-import play.templates.TemplateMagic._
-    
-    
-import play.api.templates._
-import play.api.templates.PlayMagic._
+  val additionalImports = """
 import models._
 import controllers._
 import play.api.i18n._
 import play.api.mvc._
 import play.api.data._
-import views.html._"""
+import views.html._
+"""
 
   /**
    * invokes compile method of template compiler and returns generated source object or
@@ -39,7 +35,7 @@ import views.html._"""
       logger.debug(s"Template file '${source.getAbsolutePath}' must be located in '$sourcePath' or one of its subfolders!")
 
     Try {
-      templateCompiler.compileVirtual(content, source, playProject.sourceDir, "play.api.templates.Html", "play.api.templates.HtmlFormat", additionalImports)
+      templateCompiler.compileVirtual(content, source, playProject.sourceDir, "play.api.templates.Html", "play.api.templates.HtmlFormat", additionalImports + playProject.cachedPreferenceStore.getString(PlayPreferences.TemplateImports))
     } recoverWith {
       case TemplateCompilationError(source, message, line, column) =>
         val offset = PositionHelper.convertLineColumnToOffset(content, line, column)
@@ -100,4 +96,4 @@ object PositionHelper {
       }
     }
   }
-}
\ No newline at end of file
+}
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/util/Play2PropertyTester.scala b/org.scala-ide.play2/src/org/scalaide/play2/util/Play2PropertyTester.scala
new file mode 100644
index 00000000..b0860731
--- /dev/null
+++ b/org.scala-ide.play2/src/org/scalaide/play2/util/Play2PropertyTester.scala
@@ -0,0 +1,36 @@
+package org.scalaide.play2.util
+
+import org.eclipse.core.expressions.PropertyTester
+import org.eclipse.core.resources.IProject
+import org.scalaide.play2.PlayPlugin
+import org.eclipse.jdt.core.IJavaProject
+
+object Play2PropertyTester {
+  final val IsPlayProject = "isPlay2Project"
+}
+
+/** Eclipse property tester. Can check if a project is a play2 project.
+ */
+class Play2PropertyTester() extends PropertyTester {
+
+  // from IPropertyTester
+
+  override def test(receiver: Any, property: String, args: Array[Object], expectedValue: Any): Boolean = {
+    import Play2PropertyTester._
+
+    property match {
+      case IsPlayProject =>
+        receiver match {
+          case project: IProject =>
+            PlayPlugin.plugin.asPlayProject(project).isDefined
+          case project: IJavaProject =>
+            PlayPlugin.plugin.asPlayProject(project.getProject()).isDefined
+          case _ =>
+            false
+        }
+      case _ =>
+        false
+    }
+  }
+
+}
\ No newline at end of file
diff --git a/org.scala-ide.play2/src/org/scalaide/play2/util/SyncedScopedPreferenceStore.scala b/org.scala-ide.play2/src/org/scalaide/play2/util/SyncedScopedPreferenceStore.scala
new file mode 100644
index 00000000..99912303
--- /dev/null
+++ b/org.scala-ide.play2/src/org/scalaide/play2/util/SyncedScopedPreferenceStore.scala
@@ -0,0 +1,16 @@
+package org.scalaide.play2.util
+
+import org.eclipse.core.resources.IProject
+import org.eclipse.core.resources.ProjectScope
+import org.eclipse.ui.preferences.ScopedPreferenceStore
+
+class SyncedScopedPreferenceStore(project: IProject, pluginId: String) {
+
+  private val preferenceStore = new ScopedPreferenceStore(new ProjectScope(project), pluginId)
+
+  def getString(name: String): String = {
+    preferenceStore.synchronized {
+      preferenceStore.getString(name)
+    }
+  }
+}
\ No newline at end of file