Changeset 4a686c60d84cd90bacfd042a704be56f7e6c1921 in indico

Timestamp:

01/17/12 15:56:30 (4 months ago)

Author:

Alberto Resco Perez <alberto.resco.perez@…>

Children:

98d4e60409aca1749b7dbfe7caf1353a34e5998a

Parents:

f6afd0af7bf586cff134a6f7f1410f98839f00bf

git-author:

Alberto Resco Perez <alberto.resco.perez@…> (01/17/12 15:56:30)

git-committer:

Jose Benito <jose.benito.gonzalez@…> (02/14/12 17:37:05)

Message:

[FTR] Add analytics support

• Created a new tab in Administration->Services.
• Allows to enable/disable the analytics.
• Allows to set the analytics code.
• Includes, if enabled, the code in the Header or Body.
• Closes #973.

Files:

• bin/utils/getAllCatAccess.py (added)
• indico/MaKaC/common/info.py (modified) (2 diffs)
• indico/MaKaC/webinterface/pages/admins.py (modified) (2 diffs)
• indico/MaKaC/webinterface/rh/services.py (modified) (1 diff)
• indico/MaKaC/webinterface/tpls/Analytics.tpl (added)
• indico/MaKaC/webinterface/tpls/HTMLHeader.tpl (modified) (2 diffs)
• indico/MaKaC/webinterface/urlHandlers.py (modified) (1 diff)
• indico/MaKaC/webinterface/wcomponents.py (modified) (1 diff)
• indico/htdocs/adminServices.py (modified) (1 diff)

indico/MaKaC/common/info.py

@@ -88 +88 @@
         self._apiCacheTTL = 600
         self._apiSignatureTTL = 600
+        self._analyticsActive = False
+        self._analyticsCode = ""
+        self._analyticsCodeLocation = "head"
 
         # Event display style manager
@@ -435 +438 @@
         self._apiSignatureTTL = v
 
-
+    def isAnalyticsActive(self):
+        if hasattr(self, '_analyticsActive'):
+            return self._analyticsActive
+        else:
+            self._analyticsActive = False
+            return False
+
+    def setAnalyticsActive(self, v):
+        self._analyticsActive = v
+
+    def getAnalyticsCode(self):
+        if hasattr(self, '_analyticsCode'):
+            return self._analyticsCode
+        else:
+            self._analyticsCode = ""
+            return ""
+
+    def setAnalyticsCode(self, v):
+        self._analyticsCode = v
+
+
+    def getAnalyticsCodeLocation(self):
+        if hasattr(self, '_analyticsCodeLocation'):
+            return self._analyticsCodeLocation
+        else:
+            self._analyticsCodeLocation = ""
+            return ""
+
+    def setAnalyticsCodeLocation(self, v):
+        self._analyticsCodeLocation = v
 
 class HelperMaKaCInfo:

indico/MaKaC/webinterface/pages/admins.py

@@ -469 +469 @@
         self._subTabHTTPAPI_Keys = self._subTabHTTPAPI.newSubTab( "api_keys", _("API Keys"), \
                 urlHandlers.UHAdminAPIKeys.getURL() )
+        self._subTabAnalytics = self._tabCtrl.newTab( "analytics", _("Analytics"), \
+                urlHandlers.UHAnalytics.getURL() )
 
     def _getPageContent(self, params):
@@ -2615 +2617 @@
         vars["removeIcon"] = Config.getInstance().getSystemIconURL( "remove" )
         return vars
+
+
+class WPAnalytics( WPServicesCommon ):
+
+    def __init__( self, rh):
+        WPServicesCommon.__init__( self, rh )
+
+    def _getTabContent( self, params ):
+        wc = WAnalytics()
+        return wc.getHTML( params )
+
+    def _setActiveTab( self ):
+        self._subTabAnalytics.setActive()
+
+class WAnalytics(wcomponents.WTemplated):
+
+    def getVars( self ):
+        vars = wcomponents.WTemplated.getVars( self )
+        minfo = info.HelperMaKaCInfo.getMaKaCInfoInstance()
+        vars["analyticsActive"] = minfo.isAnalyticsActive()
+        vars["analyticsCode"] = minfo.getAnalyticsCode()
+        vars["analyticsCodeLocation"] = minfo.getAnalyticsCodeLocation()
+        vars["analyticsFormURL"] = urlHandlers.UHSaveAnalytics.getURL()
+        return vars

indico/MaKaC/webinterface/rh/services.py

@@ -414 +414 @@
 
         self._redirect(urlHandlers.UHOAIPrivateConfig.getURL())
+
+class RHAnalytics( RHServicesBase ):
+    _uh = urlHandlers.UHAnalytics
+
+    def _process( self ):
+        p = adminPages.WPAnalytics(self)
+        return p.display()
+
+
+class RHSaveAnalytics(RHServicesBase):
+    _uh = urlHandlers.UHSaveAnalytics
+
+    def _checkParams( self, params ):
+        RHServicesBase._checkParams( self, params )
+        self._params = params
+        self._analyticsActive = self._params.get('analyticsActive') == 'yes'
+        self._analyticsCode = self._params.get('analyticsCode')
+        self._analyticsCodeLocation = self._params.get('analyticsCodeLocation')
+        self._doNotSanitizeFields.append("analyticsCode")
+
+    def _process(self):
+        minfo = info.HelperMaKaCInfo.getMaKaCInfoInstance()
+        if 'analyticsActive' in self._params:
+            minfo.setAnalyticsActive(self._analyticsActive)
+        if 'analyticsCode' in self._params:
+            minfo.setAnalyticsCode(self._analyticsCode)
+        if 'analyticsCodeLocation' in self._params:
+            minfo.setAnalyticsCodeLocation(self._analyticsCodeLocation)
+        self._redirect( urlHandlers.UHAnalytics.getURL() )

indico/MaKaC/webinterface/tpls/HTMLHeader.tpl

@@ -19 +19 @@
 % if social.get('facebook', {}).get('appId', None):
         <meta property="fb:app_id" content="${social['facebook']['appId']}"/>
+% endif
+
+% if analyticsActive and analyticsCodeLocation == "head":
+        ${analyticsCode}
 % endif
 
@@ -69 +73 @@
     <body>
         ${ page._getWarningMessage() }
+    % if analyticsActive and analyticsCodeLocation == "body":
+        ${analyticsCode}
+    % endif

indico/MaKaC/webinterface/urlHandlers.py

@@ -3099 +3099 @@
 class UHAdminAPIKeys( URLHandler ):
     _relativeURL = "adminServices.py/apiKeys"
+
+class UHAnalytics( URLHandler ):
+    _relativeURL = "adminServices.py/analytics"
+
+class UHSaveAnalytics( URLHandler ):
+    _relativeURL = "adminServices.py/saveAnalytics"
 
 class UHBadgeTemplates( URLHandler ):

indico/MaKaC/webinterface/wcomponents.py

@@ -260 +260 @@
     def getVars( self ):
         vars = WTemplated.getVars( self )
+        minfo = info.HelperMaKaCInfo.getMaKaCInfoInstance()
+        vars["analyticsActive"] = minfo.isAnalyticsActive()
+        vars["analyticsCode"] = minfo.getAnalyticsCode()
+        vars["analyticsCodeLocation"] = minfo.getAnalyticsCodeLocation()
+
 
         if DBMgr.getInstance().isConnected():

indico/htdocs/adminServices.py

@@ -100 +100 @@
     return api.RHAdminAPIOptionsSet(req).process(params)
 
-
 def apiKeys(req, **params):
     return api.RHAdminAPIKeys(req).process(params)
+
+def analytics(req, **params):
+    return services.RHAnalytics(req).process(params)
+
+def saveAnalytics(req, **params):
+    return services.RHSaveAnalytics(req).process(params)