[CalendarServer-changes] [15072] CalendarServer/trunk/calendarserver/tools
source_changes at macosforge.org
source_changes at macosforge.org
Thu Aug 27 12:06:30 PDT 2015
Revision: 15072
http://trac.calendarserver.org//changeset/15072
Author: cdaboo at apple.com
Date: 2015-08-27 12:06:30 -0700 (Thu, 27 Aug 2015)
Log Message:
-----------
Add missing-location (with fix option) to CalVerify.
Modified Paths:
--------------
CalendarServer/trunk/calendarserver/tools/calverify.py
CalendarServer/trunk/calendarserver/tools/test/test_calverify.py
Modified: CalendarServer/trunk/calendarserver/tools/calverify.py
===================================================================
--- CalendarServer/trunk/calendarserver/tools/calverify.py 2015-08-27 16:11:05 UTC (rev 15071)
+++ CalendarServer/trunk/calendarserver/tools/calverify.py 2015-08-27 19:06:30 UTC (rev 15072)
@@ -286,6 +286,13 @@
--invalid-organizer : only detect events with an organizer not in the directory
--disabled-organizer : only detect events with an organizer disabled for calendaring
+Options for --missing-location:
+
+--uuid : only scan specified calendar homes. Can be a partial GUID
+ to scan all GUIDs with that as a prefix or "*" for all GUIDS
+ (that are marked as locations in the directory).
+--summary : report only which GUIDs have bad events - no details.
+
Options for --split:
--path : URI path to resource to split.
@@ -327,6 +334,7 @@
['missing', 'm', "Show 'orphaned' homes."],
['double', 'd', "Detect double-bookings."],
['dark-purge', 'p', "Purge room/resource events with invalid organizer."],
+ ['missing-location', 'g', "Room events with missing location."],
['split', 'l', "Split an event."],
['fix', 'x', "Fix problems."],
['verbose', 'v', "Verbose logging."],
@@ -2570,6 +2578,284 @@
+class MissingLocationService(CalVerifyService):
+ """
+ Service which detects room/resource events that have an ATTENDEE;CUTYPE=ROOM property but no Location.
+ """
+
+ def title(self):
+ return "Missing Location Service"
+
+
+ @inlineCallbacks
+ def doAction(self):
+
+ self.output.write("\n---- Scanning calendar data ----\n")
+
+ self.tzid = Timezone(tzid=self.options["tzid"] if self.options["tzid"] else "America/Los_Angeles")
+ self.now = DateTime.getNowUTC()
+ self.start = self.options["start"] if "start" in self.options else DateTime.getToday()
+ self.start.setDateOnly(False)
+ self.start.setTimezone(self.tzid)
+ self.fix = self.options["fix"]
+
+ if self.options["verbose"] and self.options["summary"]:
+ ot = time.time()
+
+ # Check loop over uuid
+ UUIDDetails = collections.namedtuple("UUIDDetails", ("uuid", "rname", "missing",))
+ self.uuid_details = []
+ if len(self.options["uuid"]) != 36:
+ self.txn = self.store.newTransaction()
+ if self.options["uuid"]:
+ homes = yield self.getMatchingHomeUIDs(self.options["uuid"])
+ else:
+ homes = yield self.getAllHomeUIDs()
+ yield self.txn.commit()
+ self.txn = None
+ uuids = []
+ if self.options["verbose"]:
+ self.output.write("%d uuids to check\n" % (len(homes,)))
+ for uuid in sorted(homes):
+ record = yield self.directoryService().recordWithUID(uuid)
+ if record is not None and record.recordType == CalRecordType.location:
+ uuids.append(uuid)
+ else:
+ uuids = [self.options["uuid"], ]
+ if self.options["verbose"]:
+ self.output.write("%d uuids to scan\n" % (len(uuids,)))
+
+ count = 0
+ for uuid in uuids:
+ self.results = {}
+ self.summary = []
+ self.total = 0
+ count += 1
+
+ record = yield self.directoryService().recordWithUID(uuid)
+ if record is None:
+ continue
+ if not record.thisServer() or not record.hasCalendars:
+ continue
+
+ rname = record.displayName
+
+ if len(uuids) > 1 and not self.options["summary"]:
+ self.output.write("\n\n-----------------------------\n")
+
+ self.txn = self.store.newTransaction()
+
+ if self.options["verbose"]:
+ t = time.time()
+ rows = yield self.getAllResourceInfoTimeRangeWithUUID(self.start, uuid)
+ descriptor = "getAllResourceInfoTimeRangeWithUUID"
+
+ yield self.txn.commit()
+ self.txn = None
+
+ if self.options["verbose"]:
+ if not self.options["summary"]:
+ self.output.write("%s time: %.1fs\n" % (descriptor, time.time() - t,))
+ else:
+ self.output.write("%s (%d/%d)" % (uuid, count, len(uuids),))
+ self.output.flush()
+
+ self.total = len(rows)
+ if not self.options["summary"]:
+ self.logResult("UUID to process", uuid)
+ self.logResult("Record name", rname)
+ self.addSummaryBreak()
+ self.logResult("Number of events to process", self.total)
+
+ if rows:
+ if not self.options["summary"]:
+ self.addSummaryBreak()
+ missing = yield self.missingLocation(rows, uuid, rname)
+ else:
+ missing = False
+
+ self.uuid_details.append(UUIDDetails(uuid, rname, missing))
+
+ if not self.options["summary"]:
+ self.printSummary()
+ else:
+ self.output.write(" - %s\n" % ("Bad Events" if missing else "OK",))
+ self.output.flush()
+
+ if count == 0:
+ self.output.write("Nothing to scan\n")
+
+ if self.options["summary"]:
+ table = tables.Table()
+ table.addHeader(("GUID", "Name", "RID", "UID",))
+ missing = 0
+ for item in sorted(self.uuid_details):
+ if not item.purged:
+ continue
+ uuid = item.uuid
+ rname = item.rname
+ for detail in item.purged:
+ table.addRow((
+ uuid,
+ rname,
+ detail.resid,
+ detail.uid,
+ ))
+ uuid = ""
+ rname = ""
+ missing += 1
+ table.addFooter(("Total", "%d" % (missing,), "", "", "",))
+ self.output.write("\n")
+ table.printTable(os=self.output)
+
+ if self.options["verbose"]:
+ self.output.write("%s time: %.1fs\n" % ("Summary", time.time() - ot,))
+
+
+ @inlineCallbacks
+ def missingLocation(self, rows, uuid, rname):
+ """
+ Check each calendar resource by looking at any ORGANIZER property value and verifying it is valid.
+ """
+
+ if not self.options["summary"]:
+ self.output.write("\n---- Checking for missing location events ----\n")
+ self.txn = self.store.newTransaction()
+
+ if self.options["verbose"]:
+ t = time.time()
+
+ Details = collections.namedtuple("Details", ("resid", "uid",))
+
+ count = 0
+ total = len(rows)
+ details = []
+ fixed = 0
+ rjust = 10
+ for resid in rows:
+ resid = resid[1]
+ caldata = yield self.getCalendar(resid, self.fix)
+ if caldata is None:
+ if self.parseError:
+ returnValue((False, self.parseError))
+ else:
+ returnValue((True, "Nothing to scan"))
+
+ cal = Component(None, pycalendar=caldata)
+ uid = cal.resourceUID()
+
+ fail = False
+ if cal.getOrganizer() is not None:
+ for comp in cal.subcomponents():
+ if comp.name() != "VEVENT":
+ continue
+ location = comp.propertyValue("LOCATION")
+ if location is None:
+ fail = True
+ break
+ else:
+ # Test the actual location value matches this location name?
+ pass
+
+ if fail:
+ details.append(Details(resid, uid,))
+ if self.fix:
+ yield self.fixCalendarData(cal, rname)
+ fixed += 1
+
+ if self.options["verbose"] and not self.options["summary"]:
+ if count == 1:
+ self.output.write("Current".rjust(rjust) + "Total".rjust(rjust) + "Complete".rjust(rjust) + "\n")
+ if divmod(count, 100)[1] == 0:
+ self.output.write((
+ "\r" +
+ ("%s" % count).rjust(rjust) +
+ ("%s" % total).rjust(rjust) +
+ ("%d%%" % safePercent(count, total)).rjust(rjust)
+ ).ljust(80))
+ self.output.flush()
+
+ # To avoid holding locks on all the rows scanned, commit every 100 resources
+ if divmod(count, 100)[1] == 0:
+ yield self.txn.commit()
+ self.txn = self.store.newTransaction()
+
+ yield self.txn.commit()
+ self.txn = None
+ if self.options["verbose"] and not self.options["summary"]:
+ self.output.write((
+ "\r" +
+ ("%s" % count).rjust(rjust) +
+ ("%s" % total).rjust(rjust) +
+ ("%d%%" % safePercent(count, total)).rjust(rjust)
+ ).ljust(80) + "\n")
+
+ # Print table of results
+ if not self.options["summary"]:
+ self.logResult("Number of bad events", len(details))
+
+ self.results["Bad Events"] = details
+ if self.fix:
+ self.results["Fix bad events"] = fixed
+
+ if self.options["verbose"] and not self.options["summary"]:
+ diff_time = time.time() - t
+ self.output.write("Time: %.2f s Average: %.1f ms/resource\n" % (
+ diff_time,
+ safePercent(diff_time, total, 1000.0),
+ ))
+
+ returnValue(details)
+
+
+ @inlineCallbacks
+ def fixCalendarData(self, cal, rname):
+ """
+ Fix problems in calendar data using store APIs.
+ """
+
+ # Extract organizer (strip off urn:x-uid:) and UID
+ organizer = cal.getOrganizer()[10:]
+ uid = cal.resourceUID()
+ _ignore_calendar, resid, _ignore_created, _ignore_modified = yield self.getCalendarForOwnerByUID(organizer, uid)
+
+ # Get the organizer's calendar object and data
+ homeID, calendarID = yield self.getAllResourceInfoForResourceID(resid)
+ home = yield self.txn.calendarHomeWithResourceID(homeID)
+ calendar = yield home.childWithID(calendarID)
+ calendarObj = yield calendar.objectResourceWithID(resid)
+
+ try:
+ component = yield calendarObj.componentForUser()
+ except InternalDataStoreError:
+ returnValue((False, "Failed parse: "))
+
+ # Add missing location to all components (need to dup component when modifying)
+ component = component.duplicate()
+ for comp in component.subcomponents():
+ if comp.name() != "VEVENT":
+ continue
+ location = comp.propertyValue("LOCATION")
+ if location is None:
+ comp.addProperty(Property("LOCATION", rname))
+
+ # Write out fix, commit and get a new transaction
+ result = True
+ message = ""
+ try:
+ yield calendarObj.setComponent(component)
+ except Exception, e:
+ print(e, component)
+ print(traceback.print_exc())
+ result = False
+ message = "Exception fix: "
+ yield self.txn.commit()
+ self.txn = self.store.newTransaction()
+
+ returnValue((result, message,))
+
+
+
class EventSplitService(CalVerifyService):
"""
Service which splits a recurring event at a specific date-time value.
@@ -2720,6 +3006,8 @@
return DoubleBookingService(store, options, output, reactor, config)
elif options["dark-purge"]:
return DarkPurgeService(store, options, output, reactor, config)
+ elif options["missing-location"]:
+ return MissingLocationService(store, options, output, reactor, config)
elif options["split"]:
return EventSplitService(store, options, output, reactor, config)
else:
Modified: CalendarServer/trunk/calendarserver/tools/test/test_calverify.py
===================================================================
--- CalendarServer/trunk/calendarserver/tools/test/test_calverify.py 2015-08-27 16:11:05 UTC (rev 15071)
+++ CalendarServer/trunk/calendarserver/tools/test/test_calverify.py 2015-08-27 19:06:30 UTC (rev 15072)
@@ -14,6 +14,7 @@
# limitations under the License.
##
from __future__ import print_function
+from twext.enterprise.jobs.jobitem import JobItem
"""
Tests for calendarserver.tools.calverify
@@ -21,7 +22,7 @@
from calendarserver.tools.calverify import BadDataService, \
SchedulingMismatchService, DoubleBookingService, DarkPurgeService, \
- EventSplitService
+ EventSplitService, MissingLocationService
from pycalendar.datetime import DateTime
@@ -505,7 +506,7 @@
sync_token_new = (yield (yield self.calendarUnderTest()).syncToken())
self.assertNotEqual(sync_token_old, sync_token_new)
- # Make sure mailto: fix results in urn:uuid value without SCHEDULE-AGENT
+ # Make sure mailto: fix results in urn:x-uid value without SCHEDULE-AGENT
obj = yield self.calendarObjectUnderTest(name="bad10.ics")
ical = yield obj.component()
org = ical.getOrganizerProperty()
@@ -2793,3 +2794,209 @@
self.assertTrue("%(now_fwd10)s" % self.subs in result)
self.assertTrue("%(now_fwd11)s *" % self.subs in result)
self.assertTrue("%(now_fwd12)s" % self.subs in result)
+
+
+
+class CalVerifyMissingLocations(CalVerifyMismatchTestsBase):
+ """
+ Tests calverify for events.
+ """
+
+ subs = {
+ "year": nowYear,
+ "month": nowMonth,
+ "uuid1": CalVerifyMismatchTestsBase.uuid1,
+ "uuid2": CalVerifyMismatchTestsBase.uuid2,
+ "uuid3": CalVerifyMismatchTestsBase.uuid3,
+ "uuidl1": CalVerifyMismatchTestsBase.uuidl1,
+ }
+
+ # Valid event
+ VALID_ICS = """BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Apple Inc.//iCal 4.0.1//EN
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+CREATED:20100303T181216Z
+UID:VALID_ICS
+TRANSP:OPAQUE
+SUMMARY:VALID_ICS
+DTSTART:%(year)s%(month)02d08T100000Z
+DURATION:PT1H
+DTSTAMP:20100303T181220Z
+SEQUENCE:2
+ORGANIZER:urn:x-uid:%(uuid1)s
+ATTENDEE:urn:x-uid:%(uuid1)s
+ATTENDEE:urn:x-uid:%(uuid2)s
+ATTENDEE:urn:x-uid:%(uuidl1)s
+LOCATION:Location 1
+END:VEVENT
+END:VCALENDAR
+""".replace("\n", "\r\n") % subs
+
+ # Invalid event
+ INVALID_ICS = """BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//Apple Inc.//iCal 4.0.1//EN
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+CREATED:20100303T181216Z
+UID:INVALID_ICS
+TRANSP:OPAQUE
+SUMMARY:INVALID_ICS
+DTSTART:%(year)s%(month)02d08T120000Z
+DURATION:PT1H
+DTSTAMP:20100303T181220Z
+SEQUENCE:2
+ORGANIZER:urn:x-uid:%(uuid1)s
+ATTENDEE:urn:x-uid:%(uuid1)s
+ATTENDEE:urn:x-uid:%(uuid2)s
+ATTENDEE:urn:x-uid:%(uuidl1)s
+END:VEVENT
+END:VCALENDAR
+""".replace("\n", "\r\n") % subs
+
+ allEvents = {
+ "invite1.ics" : (VALID_ICS, CalVerifyMismatchTestsBase.metadata,),
+ "invite2.ics" : (INVALID_ICS, CalVerifyMismatchTestsBase.metadata,),
+ }
+
+ requirements = {
+ CalVerifyMismatchTestsBase.uuid1 : {
+ "calendar" : allEvents,
+ "inbox" : {},
+ },
+ CalVerifyMismatchTestsBase.uuid2 : {
+ "calendar" : allEvents,
+ "inbox" : {},
+ },
+ CalVerifyMismatchTestsBase.uuid3 : {
+ "calendar" : {},
+ "inbox" : {},
+ },
+ CalVerifyMismatchTestsBase.uuidl1 : {
+ "calendar" : allEvents,
+ "inbox" : {},
+ },
+ }
+
+ @inlineCallbacks
+ def test_scanMissingLocations(self):
+ """
+ MissingLocationService.doAction without fix for missing locations. Make sure it detects
+ as much as it can. Make sure sync-token is not changed.
+ """
+
+ sync_token_oldl1 = (yield (yield self.calendarUnderTest(home=self.uuidl1, name="calendar")).syncToken())
+ yield self.commit()
+
+ options = {
+ "ical": False,
+ "badcua": False,
+ "mismatch": False,
+ "nobase64": False,
+ "double": False,
+ "dark-purge": False,
+ "missing-location": True,
+ "fix": False,
+ "verbose": False,
+ "details": False,
+ "summary": False,
+ "days": 365,
+ "uid": "",
+ "uuid": self.uuidl1,
+ "tzid": "utc",
+ "start": DateTime(nowYear, 1, 1, 0, 0, 0),
+ "no-organizer": False,
+ "invalid-organizer": False,
+ "disabled-organizer": False,
+ }
+ output = StringIO()
+ calverify = MissingLocationService(self._sqlCalendarStore, options, output, reactor, config)
+ yield calverify.doAction()
+
+ self.assertEqual(calverify.results["Number of events to process"], len(self.requirements[CalVerifyMismatchTestsBase.uuidl1]["calendar"]))
+ self.assertEqual(
+ sorted([i.uid for i in calverify.results["Bad Events"]]),
+ ["INVALID_ICS", ]
+ )
+ self.assertEqual(calverify.results["Number of bad events"], 1)
+ self.assertTrue("Fix bad events" not in calverify.results)
+
+ sync_token_newl1 = (yield (yield self.calendarUnderTest(home=self.uuidl1, name="calendar")).syncToken())
+ self.assertEqual(sync_token_oldl1, sync_token_newl1)
+
+
+ @inlineCallbacks
+ def test_fixMissingLocations(self):
+ """
+ MissingLocationService.doAction with fix for missing locations. Make sure it detects
+ as much as it can. Make sure sync-token is changed.
+ """
+
+ # Make sure location is in each users event
+ for uid in (self.uuid1, self.uuid2, self.uuidl1,):
+ calobj = yield self.calendarObjectUnderTest(home=uid, calendar_name="calendar", name="invite2.ics")
+ caldata = yield calobj.componentForUser()
+ self.assertTrue("LOCATION:" not in str(caldata))
+ yield self.commit()
+
+ sync_token_oldl1 = (yield (yield self.calendarUnderTest(home=self.uuidl1, name="calendar")).syncToken())
+ yield self.commit()
+
+ options = {
+ "ical": False,
+ "badcua": False,
+ "mismatch": False,
+ "nobase64": False,
+ "double": False,
+ "dark-purge": False,
+ "missing-location": True,
+ "fix": True,
+ "verbose": False,
+ "details": False,
+ "summary": False,
+ "days": 365,
+ "uid": "",
+ "uuid": self.uuidl1,
+ "tzid": "utc",
+ "start": DateTime(nowYear, 1, 1, 0, 0, 0),
+ "no-organizer": False,
+ "invalid-organizer": False,
+ "disabled-organizer": False,
+ }
+ output = StringIO()
+ calverify = MissingLocationService(self._sqlCalendarStore, options, output, reactor, config)
+ yield calverify.doAction()
+
+ self.assertEqual(calverify.results["Number of events to process"], len(self.requirements[CalVerifyMismatchTestsBase.uuidl1]["calendar"]))
+ self.assertEqual(
+ sorted([i.uid for i in calverify.results["Bad Events"]]),
+ ["INVALID_ICS", ]
+ )
+ self.assertEqual(calverify.results["Number of bad events"], 1)
+ self.assertEqual(calverify.results["Fix bad events"], 1)
+
+ sync_token_newl1 = (yield (yield self.calendarUnderTest(home=self.uuidl1, name="calendar")).syncToken())
+ self.assertNotEqual(sync_token_oldl1, sync_token_newl1)
+ yield self.commit()
+
+ # Wait for it to complete
+ yield JobItem.waitEmpty(self._sqlCalendarStore.newTransaction, reactor, 60)
+
+ # Re-scan after changes to make sure there are no errors
+ options["fix"] = False
+ options["uuid"] = self.uuidl1
+ calverify = MissingLocationService(self._sqlCalendarStore, options, output, reactor, config)
+ yield calverify.doAction()
+
+ self.assertEqual(calverify.results["Number of events to process"], len(self.requirements[CalVerifyMismatchTestsBase.uuidl1]["calendar"]))
+ self.assertEqual(len(calverify.results["Bad Events"]), 0)
+ self.assertTrue("Fix bad events" not in calverify.results)
+
+ # Make sure location is in each users event
+ for uid in (self.uuid1, self.uuid2, self.uuidl1,):
+ calobj = yield self.calendarObjectUnderTest(home=uid, calendar_name="calendar", name="invite2.ics")
+ caldata = yield calobj.componentForUser()
+ self.assertTrue("LOCATION:" in str(caldata))
+ yield self.commit()
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20150827/39241f13/attachment-0001.html>
More information about the calendarserver-changes
mailing list