Is it possible to search the Confluence Databases for instances of a specific macros?

Ian Mason

We are looking to remove/disable a macros on our instance of confluence, but we need to run a check to see if any pages are using the plugin to preclude their media from breaking? Can one query the Confluence DB for occurrences of a macros on any pages within Confluence?

discountrobot

Hey, Ian.

You can do this via the XMLRPC

Here is a example written in python finding all pages with a instance of the thumbnail macro (ac:thumbnail)

Once complete all links containing said macro are written to a errors.json file.

#!/usr/bin/env python
import xmlrpclib
import json

class bcolors:
    HEADER = '\033[95m'
    OKBLUE = '\033[94m'
    OKGREEN = '\033[92m'
    WARNING = '\033[93m'
    FAIL = '\033[91m'
    ENDC = '\033[0m'

    def disable(self):
        self.HEADER = ''
        self.OKBLUE = ''
        self.OKGREEN = ''
        self.WARNING = ''
        self.FAIL = ''
        self.ENDC = ''

#Confluence XML-RPC info
url 		= 'http://localhost:1990/rpc/xmlrpc'
client 		= xmlrpclib.Server(url, verbose=0);
authToken	= client.confluence2.login("admin", "admin");
spaces 		= client.confluence2.getSpaces(authToken);
# Error stack
errors 		= []
# Macro definition we're looking for
macro = "ac:thumbnail"

for space in spaces:
  print ("Parsing space: " + space['name']);
  spacePages = client.confluence2.getPages(authToken,space['key'])
  for spacePage in spacePages:
      print ("- Parsing page: " + spacePage['title']);
      # get the page in question with content
      page = client.confluence2.getPage(authToken, spacePage["id"])
      # did we find the macro definition?
      if(page["content"].find(macro) > 0):
        print ("{0}Found {1} macro!{2}".format(bcolors.WARNING, macro, bcolors.ENDC))
        errors.append(spacePage["url"])

# print the errors
for error in errors:
	print error["url"]

#store the errors
with open('errors.json', 'w') as outfile:
  json.dump([errors], outfile)

client.confluence2.logout(authToken)