def numberOfModifiedRecord(self):
indexer = self.services.getIndexer()
portalQuery = self.services.getPortalManager().get(self.portal.getName()).getQuery()
portalSearchQuery = self.services.getPortalManager().get(self.portal.getName()).getSearchQuery()
# Security prep work
current_user = self.page.authentication.get_username()
security_roles = self.page.authentication.get_roles_list()
security_filter = 'security_filter:("' + '" OR "'.join(security_roles) + '")'
security_exceptions = 'security_exception:"' + current_user + '"'
owner_query = 'owner:"' + current_user + '"'
security_query = "(" + security_filter + ") OR (" + security_exceptions + ") OR (" + owner_query + ")"
req = SearchRequest("modified:true")
req.setParam("fq", 'item_type:"object"')
if portalQuery:
req.addParam("fq", portalQuery)
if portalSearchQuery:
req.addParam("fq", portalSearchQuery)
req.addParam("fq", "")
req.setParam("rows", "0")
if not self.page.authentication.is_admin():
req.addParam("fq", security_query)
out = ByteArrayOutputStream()
indexer.search(req, out)
self.__result = JsonSimpleConfig(ByteArrayInputStream(out.toByteArray()))
return self.__result.getString(None, "response", "numFound")
def getWatcherConfig(self):
watcherPath = self.sysConfig.getString("${fascinator.home}/watcher)",
["watcher", "path"])
configFile = File("%s/app/config.json" % watcherPath)
if configFile.exists():
return JsonSimpleConfig(configFile)
return None
def __search(self, searchField):
indexer = self.services.getIndexer()
portalQuery = self.services.getPortalManager().get(
self.portal.getName()).getQuery()
portalSearchQuery = self.services.getPortalManager().get(
self.portal.getName()).getSearchQuery()
# Security prep work
current_user = self.page.authentication.get_username()
security_roles = self.page.authentication.get_roles_list()
security_filter = 'security_filter:("' + '" OR "'.join(
security_roles) + '")'
security_exceptions = 'security_exception:"' + current_user + '"'
owner_query = 'owner:"' + current_user + '"'
security_query = "(" + security_filter + ") OR (" + security_exceptions + ") OR (" + owner_query + ")"
startRow = 0
numPerPage = 25
numFound = 0
req = SearchRequest(searchField)
if portalQuery:
req.addParam("fq", portalQuery)
if portalSearchQuery:
req.addParam("fq", portalSearchQuery)
if not self.page.authentication.is_admin():
req.addParam("fq", security_query)
objectIdList = []
while True:
req.addParam("fq", 'item_type:"object"')
req.addParam("rows", str(numPerPage))
req.addParam("start", str(startRow))
out = ByteArrayOutputStream()
indexer.search(req, out)
result = JsonSimpleConfig(ByteArrayInputStream(out.toByteArray()))
docs = result.getJsonList("response", "docs")
docIds = []
for doc in docs:
docId = doc.getString(None, "storage_id")
if docId is not None:
docIds.append(docId)
objectIdList.extend(docs)
startRow += numPerPage
numFound = int(result.getString(None, "response", "numFound"))
if (startRow > numFound):
break
return objectIdList
def __getPackageTypeAndJsonConfigFile(self, packageType):
try:
types = JsonSimpleConfig().getJsonSimpleMap(
["portal", "packageTypes"])
pt = None
if types is not None and not types.isEmpty():
pt = types.get(packageType)
if pt is None:
configFile = "packaging-config.json"
else:
configFile = pt.getString("packaging-config.json",
["jsonconfig"])
except Exception, e:
configFile = "packaging-config.json"
def __getPackageTypeAndJsonConfigFile(self):
try:
packageType = self.vc("formData").get("packageType", "default")
if packageType == "":
packageType = "default"
types = JsonSimpleConfig().getJsonSimpleMap(
["portal", "packageTypes"])
pt = None
if types is not None and not types.isEmpty():
pt = types.get(packageType)
if pt is None:
configFile = "packaging-config.json"
else:
self.vc("log").error("Getting pt: %s" % pt)
configFile = pt.getString("packaging-config.json",
["jsonconfig"])
self.vc("log").error("Getting configFile: %s" % configFile)
except Exception, e:
configFile = "packaging-config.json"
def __activate__(self, context):
self.sysConfig = JsonSimpleConfig()
self.velocityContext = context
self.log = context["log"]
self.__meta = {}
formData = self.vc("formData")
self.isAjax = formData.get("ajax") != None
if self.isAjax:
ok = JsonObject()
ok.put("ok", "OK")
self.json = ok.toString()
else:
self.json = ""
self.__selectedPackageType = formData.get("packageType", "default")
self.log.debug("formData = %s" % self.vc("formData"))
self.log.debug("selectedPackageType = '%s'" %
self.__selectedPackageType)
self.__meta["packageType"] = formData.get("packageType", "default")
self.__meta["description"] = formData.get("description", "")
def __init__(self):
self.sysConfig = JsonSimpleConfig()
def __activate__(self, context):
if self.tokensDB is None:
self.tokensDB = TokensDatabase(context)
# Set up configuration
self.systemConfig = JsonSimpleConfig()
self.oaiConfig = None
self.getMetadataFormats()
self.velocityContext = context
self.services = context["Services"]
self.log = context["log"]
self.sessionState = context["sessionState"]
self.portalDir = context["portalDir"]
self.__result = None
self.lastPage = False
# Check if the OAI request has an overriding portal ('set') to the URL
paramSet = self.vc("formData").get("set")
self.__portalName = context["page"].getPortal().getName()
illegalSet = False
if paramSet is not None:
portals = self.vc("page").getPortals().keySet()
if portals.contains(paramSet):
self.__portalName = paramSet
else:
illegalSet = True
self.__metadataPrefix = ""
self.__sessionExpiry = self.systemConfig.getInteger(
None, ["portal", "oai-pmh", "sessionExpiry"])
# Check if there's a resumption token in the formData
self.__currentToken = None
resumptionToken = self.vc("formData").get("resumptionToken")
if resumptionToken is not None:
token = self.tokensDB.getToken(resumptionToken)
self.__currentToken = token
# Process/parse the request we've received for validity
self.vc("request").setAttribute("Content-Type", "text/xml")
self.__request = OaiPmhVerb(context, self.tokensDB,
self.__currentToken)
if self.getError() is None and illegalSet:
self.__request.setError("badArgument",
"Set '%s' is not valid!" % paramSet)
# If there are no errors... and the request requires some additional
# data (like a search result) do so now. Everything else can be
# handled in the templates.
if self.getError() is None and \
self.getVerb() in ["GetRecord", "ListIdentifiers", "ListRecords"]:
# Find the metadata prefix requested
self.__metadataPrefix = self.vc("formData").get("metadataPrefix")
if self.__metadataPrefix is None:
self.__metadataPrefix = self.__currentToken.getMetadataPrefix()
if resumptionToken is None:
self.__buildResumptionTokenSets()
else:
self.__result = SolrResult(self.__currentToken.getResultJson())
# Only list records if the metadata format is enabled in this view
if self.isInView(self.__metadataPrefix) == False:
self.__result = None
def __init__(self, context, tokenDB, currentToken):
self.log = context["log"]
self.config = JsonSimpleConfig()
formData = context["formData"]
self.__error = None
self.__verb = formData.get("verb")
self.__metadataFormats = self.__metadataFormatList()
self.__fromDate = None
self.__untilDate = None
self.log.debug(" * OAI Verb = '{}'", self.__verb)
# No verb provided
if self.__verb is None:
self.__error = OaiPmhError("badVerb", "No verb was specified")
# Some verbs require additional data
elif self.__verb in ["GetRecord", "ListIdentifiers", "ListRecords"]:
# What format metadata is requested?
self.__metadataPrefix = formData.get("metadataPrefix")
if self.__metadataPrefix is None:
# No metadata supplied, error...
# unless the are resuming an earlier request
if currentToken is not None:
# Make sure the resumption token hasn't expired
if currentToken.getExpiry() > System.currentTimeMillis():
# And retrieve the metadata prefix from the last request
self.__metadataPrefix = currentToken.getMetadataPrefix(
)
# Expired token, make sure it's not in the database anymore
else:
self.log.error("Using an expired token")
self.__error = OaiPmhError("badResumptionToken",
"Token has expired")
success = tokenDB.removeToken(currentToken)
if not success:
self.log.error("Error removing expired token!")
# No prefix and no token. We're done
else:
attemptedToken = context["formData"].get("resumptionToken")
# Either they used an invalid token
if attemptedToken is not None:
self.log.error("Illegal resumption token: '{}'",
attemptedToken)
self.__error = OaiPmhError("badResumptionToken",
"Illegal resumption token")
# Or were missing their metadata prefix
else:
self.log.error(
"No metadata prefix supplied, and no token")
self.__error = OaiPmhError("badArgument",
"Metadata prefix required")
# These verbs require a metadata format... and we must be able to support it
elif self.__metadataPrefix not in self.__metadataFormats:
self.log.error("Metadata prefix is not valid for this view")
self.__error = OaiPmhError(
"cannotDisseminateFormat",
"Record not available as metadata type: %s" %
self.__metadataPrefix)
# These verbs allow for date limits, validate them if found
if self.__verb in ["ListIdentifiers", "ListRecords"]:
# From date
fromStr = context["formData"].get("from")
fromTIndex = None
if fromStr is not None:
fromTIndex = fromStr.find("T")
# Basic dates
try:
if fromTIndex == -1:
self.__fromDate = datetime.strptime(
fromStr, "%Y-%m-%d")
# Or datetimes
else:
self.__fromDate = datetime.strptime(
fromStr, "%Y-%m-%dT%H:%M:%SZ")
except:
self.log.error("Invalid FROM date: '{}'", fromStr)
self.__error = OaiPmhError(
"badArgument", "From date not in valid format!")
return
# Until Date
untilStr = context["formData"].get("until")
if untilStr is not None:
untilTIndex = untilStr.find("T")
# Granularity mismatches
if (fromTIndex is not None) and \
((fromTIndex == -1 and untilTIndex != -1) or \
(fromTIndex != -1 and untilTIndex == -1)):
self.log.error(
"Date granularity mismatch: '{}' vs '{}'", fromStr,
untilStr)
self.__error = OaiPmhError(
"badArgument", "Date granularity mismatch")
return
# Basic dates
try:
if untilTIndex == -1:
self.__untilDate = datetime.strptime(
untilStr, "%Y-%m-%d")
# Or datetimes
else:
self.__untilDate = datetime.strptime(
untilStr, "%Y-%m-%dT%H:%M:%SZ")
except:
self.log.error("Invalid UNTIL date: '{}'", untilStr)
self.__error = OaiPmhError(
"badArgument", "Until date not in valid format!")
return
# Sanity check
if self.__fromDate is not None and self.__untilDate is not None:
if self.__fromDate > self.__untilDate:
self.log.error("FROM date > UNTIL date: '{}' > '{}'",
fromStr, untilStr)
self.__error = OaiPmhError(
"badArgument",
"From date cannot be later then Until date!")
return
# Check for a valid identifier
if self.__verb == "GetRecord":
id = context["formData"].get("identifier")
if id is None or id == "":
self.log.error("GetRecord missing an identifier")
self.__error = OaiPmhError("badArgument",
"Identifier required")
return
# Basic verbs we will respond to easily
elif self.__verb in ["Identify", "ListMetadataFormats", "ListSets"]:
pass
# Invalid verb
else:
self.log.error("Invalid verb provided: '{}'", self.__verb)
self.__error = OaiPmhError("badVerb",
"Unknown verb: '%s'" % self.__verb)
def process(self):
self.log.debug(" * settings.py: formData={}", self.vc("formData"))
valid = self.vc("page").csrfSecurePage()
if not valid:
self.throw_error("Invalid request")
return
result = "{}"
portalManager = self.vc("Services").getPortalManager()
portal = portalManager.get(self.vc("portalId"))
func = self.vc("formData").get("func")
if func == "view-update":
portal.setDescription(self.vc("formData").get("view-description"))
portal.setQuery(self.vc("formData").get("view-query"))
portal.setSearchQuery(self.vc("formData").get("view-search-query"))
portal.setRecordsPerPage(
int(self.vc("formData").get("view-records-per-page")))
portal.setFacetCount(
int(self.vc("formData").get("view-facet-count")))
portal.setFacetDisplay(
int(self.vc("formData").get("view-facet-display")))
portal.setFacetSort(
self.vc("formData").get("view-facet-sort") is not None)
portalManager.save(portal)
elif func == "general-update":
config = JsonSimpleConfig()
email = StringUtils.trimToEmpty(
self.vc("formData").get("general-email"))
systemEmail = StringUtils.trimToEmpty(
config.getString(None, ["email"]))
if systemEmail != email:
obj = config.writableSystemConfig()
obj.put("email", self.vc("formData").get("general-email"))
obj.put("configured", "true")
config.storeSystemConfig()
# mark restart
self.vc("Services").getHouseKeepingManager(
).requestUrgentRestart()
else:
self.log.debug(
" * settings.py: email not updated: did not change")
self.throw_error("Email address is the same! No change saved.")
elif func == "facets-update":
portal.getObject(["portal"]).remove("facet-fields")
fields = self.vc("formData").getValues("field")
labels = self.vc("formData").getValues("label")
displays = self.vc("formData").getValues("display")
deletes = self.vc("formData").getValues("delete")
for i in range(0, len(fields)):
field = fields[i]
if deletes[i] == "false":
node = portal.writeObject(
["portal", "facet-fields", field])
node.put("label", labels[i])
node.put("display", displays[i])
portalManager.save(portal)
elif func == "sort-update":
portal.getObject(["portal"]).remove("sort-fields")
default = self.vc("formData").get("default")
if default:
portal.setSortFieldDefault(default)
order = self.vc("formData").get("order")
if order:
portal.setSortFieldDefaultOrder(order)
fields = self.vc("formData").getValues("field")
labels = self.vc("formData").getValues("label")
deletes = self.vc("formData").getValues("delete")
for i in range(0, len(fields)):
field = fields[i]
if deletes[i] == "false":
node = portal.writeObject(["portal", "sort-fields"])
node.put(field, labels[i])
portalManager.save(portal)
elif func == "watcher-update":
configFile = self.getWatcherFile()
if configFile is not None:
json = JsonSimpleConfig(configFile)
pathIds = self.vc("formData").get("pathIds").split(",")
actives = self.vc("formData").getValues("watcher-active")
if actives is None:
actives = []
deletes = self.vc("formData").getValues("watcher-delete")
if deletes is None:
deletes = []
for pathId in pathIds:
if pathId not in deletes:
path = self.vc("formData").get("%s-path" % pathId)
stopped = str(pathId not in actives).lower()
watchDir = json.writeObject(
["watcher", "watchDirs", path])
watchDir.put(
"ignoreFileFilter",
self.vc("formData").get("%s-file" % pathId))
watchDir.put(
"ignoreDirectories",
self.vc("formData").get("%s-dir" % pathId))
watchDir.put("stopped", stopped)
json.writeArray(
["watcher", "watchDirs", path, "cxtTags"])
writer = FileWriter(configFile)
writer.write(json.toString(True))
writer.close()
else:
result = "The Watcher is not installed properly."
elif func == "restore-default-config":
# backup the file
JsonSimpleConfig.backupSystemFile()
# delete the file
JsonSimpleConfig.getSystemFile().delete()
# restore default
JsonSimpleConfig.getSystemFile()
# mark restart
self.vc("Services").getHouseKeepingManager().requestUrgentRestart()
elif func == "housekeeping-update":
config = JsonSimpleConfig()
freq = StringUtils.trimToEmpty(
self.vc("formData").get("housekeeping-timeout"))
systemFreq = StringUtils.trimToEmpty(
config.getString(
None, ["portal", "houseKeeping", "config", "frequency"]))
result = "House Keeper refreshed"
if systemFreq != freq:
# Get writeable access to underlying system
sysConfig = JsonSimple(config.writableSystemConfig())
# Modify the house keeping node
hkConfig = sysConfig.writeObject(
["portal", "houseKeeping", "config"])
hkConfig.put("frequency", freq)
# Write the underlying config back to disk
config.storeSystemConfig()
result = "Frequency updated, refreshing House Keeper"
# Refresh the HouseKeeper
message = JsonObject()
message.put("type", "refresh")
self.vc("Services").getHouseKeepingManager().sendMessage(
message.toString())
self.writer.println(result)
self.writer.close()
def getWatcherFile(self):
configFile = FascinatorHome.getPathFile("watcher/config.json")
if configFile.exists():
return JsonSimpleConfig(configFile)
return None
