├── .gitignore ├── README.markdown ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src └── main └── groovy ├── AddDashboardToFavouritesForEveryone.groovy ├── AddLabelToIssue.groovy ├── CloneDashboard.groovy ├── DeleteFiltersGeneratedByScript.groovy ├── NiceIssueListFormatting.groovy ├── PrepareDashboardForNewRelease.groovy ├── ShowAllDashboards.groovy └── ShowFilters.groovy /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | build 3 | out 4 | *.ipr 5 | *.iml 6 | *.iws 7 | 8 | -------------------------------------------------------------------------------- /README.markdown: -------------------------------------------------------------------------------- 1 | # Jira script examples 2 | 3 | The purpose of this project is to serve as documentation for writing scripts that can be run using the free Script Runner add-on for Jira. 4 | 5 | ## How can I develop the scripts? 6 | Just run `gradlew` from the command line. This will download all libraries required for creating the scripts and will also generate the IntelliJ IDEA project which you can open by double clicking on the `ipr` file. 7 | 8 | ## More information about the Jira API 9 | Read these resources: 10 | - [**Atlassian Jira javadoc**](https://developer.atlassian.com/static/javadoc/jira/reference/packages.html) 11 | - [**Atlassian Jira javadoc** (select Jira version)](https://docs.atlassian.com/software/jira/docs/api) 12 | - [**Atlassian Jira plugin guide**](https://developer.atlassian.com/display/JIRADEV/JIRA+Plugin+Guide) 13 | - [**Performing Issue Operations**](https://developer.atlassian.com/display/JIRADEV/Performing+Issue+Operations) 14 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'groovy' 3 | id 'idea' 4 | } 5 | 6 | defaultTasks 'idea' 7 | 8 | repositories { 9 | mavenCentral() 10 | maven { url = 'https://maven.atlassian.com/repository/public' } 11 | } 12 | 13 | dependencies { 14 | compile 'org.codehaus.groovy:groovy-all:2.4.3' 15 | compile 'com.atlassian.jira:jira-core:6.4.7' 16 | } 17 | 18 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/igorpopovio/jira-scripting/71a3d8746fe8fc87905969fd180538d0af5fa166/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Wed Jul 15 17:01:30 EEST 2015 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.5-bin.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" >&- 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" >&- 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /src/main/groovy/AddDashboardToFavouritesForEveryone.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.component.ComponentAccessor 2 | import com.atlassian.jira.favourites.FavouritesManager 3 | import com.atlassian.jira.portal.PortalPageManager 4 | import com.atlassian.jira.user.ApplicationUser 5 | 6 | finalMessage = "" 7 | 8 | def mainMethod() { 9 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 10 | 11 | def userManager = ComponentAccessor.userManager 12 | def groupManager = ComponentAccessor.groupManager 13 | 14 | def group = "TEST GROUP" 15 | def dashboardId = 12345L 16 | def users = groupManager.getUsersInGroup(group) 17 | 18 | // users = [] 19 | // users << ComponentAccessor.userManager.getUserByKey("TEST USER") 20 | 21 | logImportantMessage "FOUND ${users.size()} users in the \"$group\" group." 22 | users.each { user -> 23 | def applicationUser = userManager.getUserByKey(user.name) 24 | if (user.active) logMessage "$user.displayName ($user.name)" 25 | addDashboardToFavouritesForUser(applicationUser, dashboardId) 26 | } 27 | 28 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 29 | } 30 | 31 | def addDashboardToFavouritesForUser(ApplicationUser user, Long dashboardId) { 32 | def favouritesManager = ComponentAccessor.getComponent(FavouritesManager.class) 33 | def dashboardManager = ComponentAccessor.getComponent(PortalPageManager.class) 34 | 35 | def dashboard = dashboardManager.getPortalPageById(dashboardId) 36 | def position = 0 37 | favouritesManager.addFavouriteInPosition(user, dashboard, position) 38 | } 39 | 40 | def logMessage(Object message) { 41 | finalMessage += "${message}
" 42 | } 43 | 44 | def logImportantMessage(Object message) { 45 | logMessage "${message}" 46 | } 47 | 48 | mainMethod() 49 | -------------------------------------------------------------------------------- /src/main/groovy/AddLabelToIssue.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.component.ComponentAccessor 2 | import com.atlassian.jira.config.properties.APKeys 3 | import com.atlassian.jira.issue.MutableIssue 4 | import com.atlassian.jira.issue.label.LabelManager 5 | import com.atlassian.jira.issue.search.SearchProvider 6 | import com.atlassian.jira.jql.parser.JqlQueryParser 7 | import com.atlassian.jira.web.bean.PagerFilter 8 | 9 | finalMessage = "" 10 | 11 | def mainMethod() { 12 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 13 | jqlQuery = "project = DEMO and text ~ 'shortcut'" 14 | logImportantMessage "Executing query: 
${jqlQuery}
" 15 | def issues = findIssues(jqlQuery) 16 | 17 | logImportantMessage "Found ${issues.size()} issues. Here they are:" 18 | logIssues(issues) 19 | 20 | def newLabel = "productivity" 21 | logImportantMessage "Will add the ${newLabel} to all mentioned issues..." 22 | issues.each { issue -> addLabelToIssue(issue, newLabel) } 23 | logImportantMessage "Successfully updated all the mentioned issues..." 24 | 25 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 26 | } 27 | 28 | def logIssues(Collection issues) { 29 | logMessage "
"
30 |     issues.each { issue -> logMessage formatIssue(issue) }
31 |     logMessage "
" 32 | } 33 | 34 | def logMessage(Object message) { 35 | finalMessage += "${message}
" 36 | } 37 | 38 | def logImportantMessage(Object message) { 39 | logMessage "${message}" 40 | } 41 | 42 | def formatIssue(MutableIssue issue) { 43 | def issueLink = getIssueLink(issue) 44 | def htmlLink = "${issue.key}" 45 | "${htmlLink} - ${issue.summary}" 46 | } 47 | 48 | def getIssueLink(MutableIssue issue) { 49 | def properties = ComponentAccessor.applicationProperties 50 | def jiraBaseUrl = properties.getString(APKeys.JIRA_BASEURL) 51 | "${jiraBaseUrl}/browse/${issue.key}" 52 | } 53 | 54 | def findIssues(String jqlQuery) { 55 | def issueManager = ComponentAccessor.issueManager 56 | def user = ComponentAccessor.jiraAuthenticationContext.user 57 | def jqlQueryParser = ComponentAccessor.getComponent(JqlQueryParser.class) 58 | def searchProvider = ComponentAccessor.getComponent(SearchProvider.class) 59 | 60 | def query = jqlQueryParser.parseQuery(jqlQuery) 61 | def results = searchProvider.search(query, user, PagerFilter.unlimitedFilter) 62 | results.issues.collect { issue -> issueManager.getIssueObject(issue.id) } 63 | } 64 | 65 | def addLabelToIssue(MutableIssue issue, String label) { 66 | def labelManager = ComponentAccessor.getComponent(LabelManager.class) 67 | def user = ComponentAccessor.jiraAuthenticationContext.user.directoryUser 68 | def sendEmailUpdates = false 69 | labelManager.addLabel(user, issue.id, label, sendEmailUpdates) 70 | } 71 | 72 | mainMethod() 73 | -------------------------------------------------------------------------------- /src/main/groovy/CloneDashboard.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.bc.JiraServiceContextImpl 2 | import com.atlassian.jira.bc.portal.PortalPageService 3 | import com.atlassian.jira.component.ComponentAccessor 4 | import com.atlassian.jira.portal.PortalPage 5 | import com.atlassian.jira.user.ApplicationUser 6 | 7 | finalMessage = "" 8 | 9 | def mainMethod() { 10 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 11 | 12 | // Here are some explanations so all this makes sense: 13 | // - the dashboards in Jira were previously called "portals" - even though they 14 | // were renamed in the web interface, they still have the same name in code. 15 | // A dashboard in Jira is represented by a "PortalPage" class and can be 16 | // managed by using the "PortalPageService". 17 | // - the gadgets are represented by a "PortletConfiguration" class 18 | // - these gadgets have a "userPrefs" map that can be changed based on need 19 | 20 | def portalPageService = ComponentAccessor.getComponent(PortalPageService.class) 21 | // def user = ComponentAccessor.jiraAuthenticationContext.user 22 | def userName = "PUT JIRA USERNAME HERE" 23 | def user = ComponentAccessor.userManager.getUserByKey(userName) 24 | 25 | def idOfPortalPageToClone = 10100L 26 | def portalPage = portalPageService.getPortalPage(createServiceContext(user), idOfPortalPageToClone) 27 | def clonedPortalPage = clonePortalPage(user, portalPage) 28 | 29 | logMessage "I have cloned the specified dashboard!" 30 | logMessage "Here is the id: " + clonedPortalPage.id 31 | 32 | logImportantMessage "------------------" 33 | 34 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 35 | } 36 | 37 | def clonePortalPage(ApplicationUser user, PortalPage portalPage) { 38 | def favourite = true 39 | def portalPageService = ComponentAccessor.getComponent(PortalPageService.class) 40 | portalPageService.createPortalPageByClone( 41 | createServiceContext(user), 42 | createNewPortalPage(portalPage), 43 | portalPage.id, 44 | favourite) 45 | } 46 | 47 | def logMessage(Object message) { 48 | finalMessage += "${message}
" 49 | } 50 | 51 | def logImportantMessage(Object message) { 52 | logMessage "${message}" 53 | } 54 | 55 | def createServiceContext(ApplicationUser user) { 56 | new JiraServiceContextImpl(user) 57 | } 58 | 59 | def createNewPortalPage(PortalPage portalPage) { 60 | PortalPage 61 | .portalPage(portalPage) 62 | .name("${portalPage.name} CLONED ON ${new Date()}") 63 | .build(); 64 | } 65 | 66 | mainMethod() 67 | -------------------------------------------------------------------------------- /src/main/groovy/DeleteFiltersGeneratedByScript.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.bc.JiraServiceContextImpl 2 | import com.atlassian.jira.bc.filter.SearchRequestService 3 | import com.atlassian.jira.component.ComponentAccessor 4 | import com.atlassian.jira.issue.search.SearchRequest 5 | import com.atlassian.jira.user.ApplicationUser 6 | import groovy.time.TimeCategory 7 | import groovy.time.TimeDuration 8 | 9 | finalMessage = "" 10 | 11 | def mainMethod() { 12 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 13 | 14 | GENERATED_BY_SCRIPT_TAG = "#generated-by-script" 15 | FILTER_OWNER = "admin" 16 | TIME = 5.minutes.ago 17 | 18 | def user = ComponentAccessor.userManager.getUserByKey(FILTER_OWNER) 19 | def filters = findAllFiltersGeneratedByScriptAndOwnedByUser(user) 20 | filters = findAllFiltersGeneratedAfter(TIME, filters) 21 | 22 | 23 | def relativeTime = new Date() - TIME 24 | logMessage "Will delete the filters generated since ${TIME} ($relativeTime ago)" 25 | logFilterDetails(filters) 26 | // deleteFilters(filters, user) 27 | 28 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 29 | } 30 | 31 | def findAllFiltersGeneratedAfter(Date date, ArrayList filters) { 32 | filters.findAll { filter -> 33 | def generationDate = extractClearDateFrom(filter.description) 34 | generationDate.after(date) 35 | } 36 | } 37 | 38 | def deleteFilters(ArrayList filters, user) { 39 | def searchRequestService = ComponentAccessor.getComponent(SearchRequestService.class) 40 | filters.each { filter -> 41 | searchRequestService.deleteFilter(createServiceContext(user), filter.id) 42 | } 43 | } 44 | 45 | def logFilterDetails(Collection filters) { 46 | filters.each { filter -> logFilterDetails(filter) } 47 | } 48 | 49 | def logFilterDetails(SearchRequest filter) { 50 | def generationDate = extractClearDateFrom(filter.description) 51 | def timeSinceGeneration = new Date() - generationDate as TimeDuration; 52 | logMessage "
" 53 | logImportantMessage "FILTER NAME: $filter.name, ID: $filter.id" 54 | logMessage "DESCRIPTION: $filter.description" 55 | logMessage "CLEAR DATE: $generationDate" 56 | logMessage "TIME SINCE CREATION: $timeSinceGeneration" 57 | logMessage "QUERY: 
$filter.query.queryString
" 58 | logMessage "
" 59 | } 60 | 61 | def extractClearDateFrom(String filterDescription) { 62 | def time = filterDescription.replace("#generated-by-script #date=", "").toLong() 63 | new Date(time) 64 | } 65 | 66 | def createServiceContext(ApplicationUser user) { 67 | new JiraServiceContextImpl(user) 68 | } 69 | 70 | def findAllFiltersGeneratedByScriptAndOwnedByUser(ApplicationUser user) { 71 | def searchRequestService = ComponentAccessor.getComponent(SearchRequestService.class) 72 | def filters = searchRequestService.getOwnedFilters(user) 73 | filters.findAll { filter -> isFilterGeneratedByScript(filter) } 74 | } 75 | 76 | def isFilterGeneratedByScript(SearchRequest filter) { 77 | filter.description?.contains(GENERATED_BY_SCRIPT_TAG) 78 | } 79 | 80 | def logMessage(Object message) { 81 | finalMessage += "${message}
" 82 | } 83 | 84 | def logImportantMessage(Object message) { 85 | logMessage "${message}" 86 | } 87 | 88 | use(TimeCategory) { mainMethod() } 89 | -------------------------------------------------------------------------------- /src/main/groovy/NiceIssueListFormatting.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.component.ComponentAccessor 2 | import com.atlassian.jira.config.properties.APKeys 3 | import com.atlassian.jira.issue.MutableIssue 4 | import com.atlassian.jira.issue.search.SearchProvider 5 | import com.atlassian.jira.jql.parser.JqlQueryParser 6 | import com.atlassian.jira.web.bean.PagerFilter 7 | 8 | finalMessage = "" 9 | 10 | def mainMethod() { 11 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 12 | jqlQuery = "project = DEMO and text ~ 'shortcut'" 13 | logImportantMessage "Executing query: 
${jqlQuery}
" 14 | def issues = findIssues(jqlQuery) 15 | 16 | logImportantMessage "Found ${issues.size()} issues. Here they are:" 17 | logIssues(issues) 18 | 19 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 20 | } 21 | 22 | def logIssues(Collection issues) { 23 | def tableStart = """ 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | """ 33 | 34 | logMessage tableStart 35 | issues.each { issue -> logMessage formatIssue(issue) } 36 | 37 | def tableEnd = "
IssueSummary
" 38 | logMessage tableEnd 39 | } 40 | 41 | def logMessage(Object message) { 42 | finalMessage += "${message}" 43 | } 44 | 45 | def logImportantMessage(Object message) { 46 | logMessage "${message}" 47 | } 48 | 49 | def formatIssue(MutableIssue issue) { 50 | def issueLink = getIssueLink(issue) 51 | def htmlLink = "${issue.key}" 52 | "$htmlLink${issue.summary}" 53 | } 54 | 55 | def getIssueLink(MutableIssue issue) { 56 | def properties = ComponentAccessor.applicationProperties 57 | def jiraBaseUrl = properties.getString(APKeys.JIRA_BASEURL) 58 | "${jiraBaseUrl}/browse/${issue.key}" 59 | } 60 | 61 | def findIssues(String jqlQuery) { 62 | def issueManager = ComponentAccessor.issueManager 63 | def user = ComponentAccessor.jiraAuthenticationContext.user 64 | def jqlQueryParser = ComponentAccessor.getComponent(JqlQueryParser.class) 65 | def searchProvider = ComponentAccessor.getComponent(SearchProvider.class) 66 | 67 | def query = jqlQueryParser.parseQuery(jqlQuery) 68 | def results = searchProvider.search(query, user, PagerFilter.unlimitedFilter) 69 | results.issues.collect { issue -> issueManager.getIssueObject(issue.id) } 70 | } 71 | 72 | mainMethod() 73 | -------------------------------------------------------------------------------- /src/main/groovy/PrepareDashboardForNewRelease.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.bc.JiraServiceContextImpl 2 | import com.atlassian.jira.bc.issue.search.SearchService 3 | import com.atlassian.jira.bc.portal.PortalPageService 4 | import com.atlassian.jira.component.ComponentAccessor 5 | import com.atlassian.jira.config.properties.APKeys 6 | import com.atlassian.jira.issue.search.SearchRequest 7 | import com.atlassian.jira.issue.search.SearchRequestManager 8 | import com.atlassian.jira.portal.PortalPage 9 | import com.atlassian.jira.portal.PortletConfiguration 10 | import com.atlassian.jira.portal.PortletConfigurationManager 11 | import com.atlassian.jira.user.ApplicationUser 12 | 13 | finalMessage = "" 14 | 15 | def mainMethod() { 16 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 17 | 18 | // Here are some explanations so all this makes sense: 19 | // - the dashboards in Jira were previously called "portals" - even though they 20 | // were renamed in the web interface, they still have the same name in code. 21 | // A dashboard in Jira is represented by a "PortalPage" class and can be 22 | // managed by using the "PortalPageService". 23 | // - the gadgets are represented by a "PortletConfiguration" class 24 | // - these gadgets have a "userPrefs" map that can be changed based on need 25 | 26 | // how to get the id: go to the URL of the dashboard and take the id 27 | // ex. http://localhost:2990/jira/secure/Dashboard.jspa?selectPageId=10100 28 | 29 | GENERATED_BY_SCRIPT_TAG = "#generated-by-script" 30 | ORIGINAL_OWNER = ComponentAccessor.userManager.getUserByKey("user") 31 | TARGET_OWNER = ComponentAccessor.userManager.getUserByKey("admin") 32 | def idOfDashboardToClone = 10500L 33 | 34 | def newDashboard = createNewDashboardBasedOn(idOfDashboardToClone) { String originalString -> 35 | originalString.replace("2014.4.0", "2015.4.0") 36 | } 37 | 38 | logImportantMessage "NEW DASHBOARD LINK" 39 | logImportantMessage getDashboardLink(newDashboard) 40 | 41 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 42 | } 43 | 44 | def createNewDashboardBasedOn(long idOfPortalPageToClone, Closure changeToApply) { 45 | def newDashboard = clonePortalPageById(idOfPortalPageToClone, changeToApply) 46 | def gadgets = extractGadgetsFrom(newDashboard) 47 | logImportantMessage "

GADGETS WITH FILTERS IN THE NEW DASHBOARD

" 48 | gadgets.each { gadget -> 49 | gadget.userPrefs.each { preference -> 50 | if (hasFilter(preference)) { 51 | logImportantMessage "GADGET ${getGadgetDetails(gadget)}" 52 | logMessage "
" 53 | 54 | SearchRequest oldFilter = extractFilterFrom(preference) 55 | logMessage "OLD FILTER" 56 | logFilterDetails(oldFilter) 57 | 58 | SearchRequest newFilter = createFilterBasedOn(oldFilter, changeToApply) 59 | logMessage "NEW FILTER" 60 | logFilterDetails(newFilter) 61 | 62 | setGadgetFilter(gadget, preference.key, newFilter) 63 | logMessage "
" 64 | } 65 | } 66 | } 67 | newDashboard 68 | } 69 | 70 | def extractGadgetsFrom(PortalPage portalPage) { 71 | def portalPageService = ComponentAccessor.getComponent(PortalPageService.class) 72 | portalPageService 73 | .getPortletConfigurations(createServiceContext(portalPage.owner), portalPage.id) 74 | .flatten() 75 | } 76 | 77 | def setGadgetFilter(PortletConfiguration gadget, String key, SearchRequest filter) { 78 | def newUserPrefs = new HashMap<>(gadget.userPrefs) 79 | newUserPrefs[key] = "filter-$filter.id".toString() 80 | gadget.userPrefs = newUserPrefs 81 | 82 | def gadgetManager = ComponentAccessor.getComponent(PortletConfigurationManager.class) 83 | gadgetManager.store(gadget) 84 | } 85 | 86 | def extractFilterFrom(Map.Entry preference) { 87 | def filterId = extractFilterIdFrom(preference) 88 | def searchRequestManager = ComponentAccessor.getComponent(SearchRequestManager.class) 89 | searchRequestManager.getSearchRequestById(filterId) 90 | } 91 | 92 | def createFilterBasedOn(SearchRequest filter, Closure changeToApply) { 93 | def oldQuery = filter.query.queryString 94 | def newQuery = changeToApply(oldQuery) 95 | def query = createQueryFromJqlQuery(newQuery) 96 | 97 | def newFilter = new SearchRequest(query) 98 | newFilter.name = changeToApply(filter.name) 99 | newFilter.owner = TARGET_OWNER 100 | newFilter.permissions = filter.permissions 101 | newFilter.description = createScriptIdentificationTag() 102 | def searchRequestManager = ComponentAccessor.getComponent(SearchRequestManager.class) 103 | searchRequestManager.create(newFilter) 104 | } 105 | 106 | def hasFilter(Map.Entry preference) { 107 | preference.value.toLowerCase().contains('filter') 108 | } 109 | 110 | def clonePortalPageById(Long idOfPortalPageToClone, Closure changeToApply) { 111 | def portalPageService = ComponentAccessor.getComponent(PortalPageService.class) 112 | def originalContextOwner = createServiceContext(ORIGINAL_OWNER) 113 | def targetContextOwner = createServiceContext(TARGET_OWNER) 114 | def portalPage = portalPageService.getPortalPage(originalContextOwner, idOfPortalPageToClone) 115 | 116 | def favourite = true 117 | def newDashboard = portalPageService.createPortalPageByClone( 118 | targetContextOwner, 119 | createNewPortalPage(portalPage, changeToApply), 120 | portalPage.id, 121 | favourite) 122 | 123 | portalPageService.updatePortalPage(targetContextOwner, 124 | newDashboard, 125 | favourite) 126 | } 127 | 128 | def logMessage(Object message) { 129 | finalMessage += "${message}
" 130 | } 131 | 132 | def logImportantMessage(Object message) { 133 | logMessage "${message}" 134 | } 135 | 136 | def createServiceContext(ApplicationUser user) { 137 | new JiraServiceContextImpl(user) 138 | } 139 | 140 | def createNewPortalPage(PortalPage portalPage, Closure changeToApply) { 141 | def name = "" 142 | name += changeToApply(portalPage.name) 143 | name += " " 144 | name += createScriptIdentificationTag() // name must be unique or else it will fail 145 | PortalPage 146 | .portalPage(portalPage) 147 | .name(name) 148 | .description(createScriptIdentificationTag()) 149 | .owner(TARGET_OWNER) 150 | .build(); 151 | } 152 | 153 | def createScriptIdentificationTag() { 154 | "$GENERATED_BY_SCRIPT_TAG #date=${new Date().getTime()}" 155 | } 156 | 157 | def extractFilterIdFrom(Map.Entry preference) { 158 | // example preference.value: "filter-12345" 159 | preference.value.replace("filter-", "").toLong() 160 | } 161 | 162 | def createQueryFromJqlQuery(String jqlQuery) { 163 | def searchService = ComponentAccessor.getComponent(SearchService.class) 164 | return searchService.parseQuery(ORIGINAL_OWNER, jqlQuery).getQuery() 165 | } 166 | 167 | def getDashboardLink(PortalPage dashboard) { 168 | def properties = ComponentAccessor.applicationProperties 169 | def jiraBaseUrl = properties.getString(APKeys.JIRA_BASEURL) 170 | def link = "$jiraBaseUrl/secure/Dashboard.jspa?selectPageId=$dashboard.id" 171 | "$dashboard.name" 172 | } 173 | 174 | def getFilterLink(SearchRequest filter) { 175 | def properties = ComponentAccessor.applicationProperties 176 | def jiraBaseUrl = properties.getString(APKeys.JIRA_BASEURL) 177 | def link = "$jiraBaseUrl/issues/?filter=$filter.id" 178 | "$filter.name" 179 | } 180 | 181 | def getGadgetDetails(PortletConfiguration gadget) { 182 | "ID: $gadget.id, ROW: $gadget.row, COLUMN: $gadget.column, TYPE: ${getGadgetType(gadget)}" 183 | } 184 | 185 | def getGadgetType(PortletConfiguration gadget) { 186 | def uri = gadget.gadgetURI.toString() 187 | def type = uri.substring(uri.lastIndexOf('/') + 1) 188 | type = type.substring(0, type.lastIndexOf('.')) 189 | type.replace('-', ' ').capitalize() 190 | } 191 | 192 | def logFilterDetails(SearchRequest filter) { 193 | logMessage "
" 194 | logImportantMessage "FILTER NAME: $filter.name, ID: $filter.id" 195 | logMessage "LINK: ${getFilterLink(filter)}" 196 | logMessage "DESCRIPTION: $filter.description" 197 | logMessage "QUERY: 
$filter.query.queryString
" 198 | logMessage "
" 199 | } 200 | 201 | mainMethod() 202 | -------------------------------------------------------------------------------- /src/main/groovy/ShowAllDashboards.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.bc.JiraServiceContextImpl 2 | import com.atlassian.jira.bc.portal.PortalPageService 3 | import com.atlassian.jira.component.ComponentAccessor 4 | import com.atlassian.jira.portal.PortletConfiguration 5 | import com.atlassian.jira.user.ApplicationUser 6 | 7 | finalMessage = "" 8 | 9 | def mainMethod() { 10 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 11 | 12 | // Here are some explanations so all this makes sense: 13 | // - the dashboards in Jira were previously called "portals" - even though they 14 | // were renamed in the web interface, they still have the same name in code. 15 | // A dashboard in Jira is represented by a "PortalPage" class and can be 16 | // managed by using the "PortalPageService". 17 | // - the gadgets are represented by a "PortletConfiguration" class 18 | // - these gadgets have a "userPrefs" map that can be changed based on need 19 | 20 | def portalPageService = ComponentAccessor.getComponent(PortalPageService.class) 21 | // def user = ComponentAccessor.jiraAuthenticationContext.user 22 | def userName = "PUT JIRA USERNAME HERE" 23 | def user = ComponentAccessor.userManager.getUserByKey(userName) 24 | def pages = portalPageService.getOwnedPortalPages(user) 25 | 26 | logImportantMessage "Showing all dashboards for the current user..." 27 | pages.each { page -> 28 | logImportantMessage "

${page.name}

" 29 | logMessage page.id 30 | logMessage page.ownerUserName 31 | logImportantMessage "CONFIGURATIONS" 32 | def configurations = portalPageService.getPortletConfigurations(createServiceContext(user), page.id) 33 | configurations.each { line -> 34 | line.each { gadget -> 35 | logImportantMessage "

${getGadgetName(gadget)}

" 36 | logMessage gadget.id 37 | logMessage gadget.color 38 | logMessage gadget.gadgetURI 39 | gadget.userPrefs.each { preference -> 40 | def isFilter = preference.key.toLowerCase().contains('filter') 41 | def preferenceStatus = "${preference.key} = ${preference.value}" 42 | if (isFilter) logImportantMessage preferenceStatus 43 | else logMessage preferenceStatus 44 | } 45 | } 46 | } 47 | logImportantMessage "------------------" 48 | } 49 | 50 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 51 | } 52 | 53 | def getGadgetName(PortletConfiguration gadget) { 54 | def uri = gadget.gadgetURI.toString() 55 | def filename = uri.substring(uri.lastIndexOf('/') + 1) 56 | filename = filename.substring(0, filename.lastIndexOf('.')) 57 | filename.replace('-', ' ').capitalize() 58 | } 59 | 60 | def logMessage(Object message) { 61 | finalMessage += "${message}
" 62 | } 63 | 64 | def logImportantMessage(Object message) { 65 | logMessage "${message}" 66 | } 67 | 68 | def createServiceContext(ApplicationUser user) { 69 | new JiraServiceContextImpl(user) 70 | } 71 | 72 | mainMethod() 73 | -------------------------------------------------------------------------------- /src/main/groovy/ShowFilters.groovy: -------------------------------------------------------------------------------- 1 | import com.atlassian.jira.bc.JiraServiceContextImpl 2 | import com.atlassian.jira.bc.filter.SearchRequestService 3 | import com.atlassian.jira.bc.issue.search.SearchService 4 | import com.atlassian.jira.component.ComponentAccessor 5 | import com.atlassian.jira.user.ApplicationUser 6 | 7 | finalMessage = "" 8 | 9 | def mainMethod() { 10 | // This script must be run from Jira -> Administration -> Add-ons -> Script Console 11 | 12 | def searchRequestService = ComponentAccessor.getComponent(SearchRequestService.class) 13 | // def user = ComponentAccessor.jiraAuthenticationContext.user 14 | def userName = "admin" 15 | def user = ComponentAccessor.userManager.getUserByKey(userName) 16 | def filter = searchRequestService.getFilter(createServiceContext(user), 10000L) 17 | 18 | logImportantMessage "Showing filter..." 19 | 20 | logMessage filter.id 21 | logMessage filter.name 22 | logMessage filter.query.queryString 23 | logMessage filter.query.whereClause.toString() 24 | 25 | def jqlQuery = filter.query.queryString + " ORDER BY issueKey" 26 | logMessage "Creating a query object from a string: \"${jqlQuery}\"" 27 | 28 | def query = createQueryFromJqlQuery(jqlQuery) 29 | logMessage query 30 | 31 | filter.query = query 32 | def persistedFilter = searchRequestService.updateFilter(createServiceContext(user), filter) 33 | logMessage "The id of the persisted filter is: ${persistedFilter.id}" 34 | 35 | logImportantMessage "------------------" 36 | 37 | return finalMessage // the returned value is shown after the execution in Jira's Web Script Console 38 | } 39 | 40 | def logMessage(Object message) { 41 | finalMessage += "${message}
" 42 | } 43 | 44 | def logImportantMessage(Object message) { 45 | logMessage "${message}" 46 | } 47 | 48 | def createServiceContext(ApplicationUser user) { 49 | new JiraServiceContextImpl(user) 50 | } 51 | 52 | def createQueryFromJqlQuery(String jqlQuery) { 53 | def user = ComponentAccessor.jiraAuthenticationContext.user.directoryUser 54 | def searchService = ComponentAccessor.getComponent(SearchService.class) 55 | 56 | def parseResult = searchService.parseQuery(user, jqlQuery); 57 | 58 | if (!parseResult.isValid()) 59 | throw new RuntimeException("The query is not valid! query = ${jqlQuery}") 60 | 61 | // not needed - it is here just so I don't forget it... 62 | def searchContext = searchService.getSearchContext(user, parseResult.getQuery()); 63 | 64 | return parseResult.getQuery() 65 | } 66 | 67 | mainMethod() 68 | --------------------------------------------------------------------------------