Functions
def	formatCVSLink
	Format CVS link.
def	formatPackageDocumentationLink
def	generateBranchHTML
	Generates HTML for Subsystem.
def	generateLeavesHTML
	Generates HTML for subpackage.
def	generateTree
	Fetches information about Subsystems/Packages/Subpackages from TagCollector.
def	loadTemplates
	Read template file.
def	parseJSON
def	preparePackageDocumentationLinks
	Extract links to package documentation.
def	prepareRefManFiles
	Prepate dictionary of doxygen generated html files.
Variables
string	baseUrl = "/cmsdoxygen/"
	block = indexPageBlockNoTree
	Formating index page's pieces.
tuple	branchHTML = generateBranchHTML(SRC_DIR, tree, subsystem)
	Generating treeviews.
list	CMSSW_VERSION = sys.argv[1]
string	contacts = ""
string	cvsBaseUrl = "https://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW"
	errorOnImport = False
tuple	fileIN = open(SCRIPTS_LOCATION+"/indexPage/indexpage_warning.html", "r")
	Warning page.
string	indexPageBlock
string	indexPageBlockNoTree
string	indexPageHTML = ""
int	indexPageRowCounter = 0
tuple	indexPageTemplateHTML = fileIN.read()
tuple	managers = parseJSON('/cmsdoxygen/tcproxy.php?type=managers')
	Index Page Preparations.
dictionary	map = {}
tuple	output = open(PROJECT_LOCATION+"/doc/html/index.html", "w")
list	packageDocLinks = []
list	PROJECT_LOCATION = sys.argv[2]
string	reason = "Failed during preparing treeview. "
dictionary	refmanfiles = {}
string	rowCssClass = "odd"
list	SCRIPTS_LOCATION = sys.argv[3]
string	SRC_DIR = "/src"
tuple	treeHTML = treeTemplateHTML.replace("@TREE@", branchHTML)
tuple	users = parseJSON('/cmsdoxygen/tcproxy.php?type=users')

Detailed Description

Created on Aug 29, 2011

@author: MantYdze

Function Documentation

def Association::formatCVSLink	(	package,
		subpackage
	)

Format CVS link.

Definition at line 62 of file Association.py.

00063                                       :
00064     cvsLink = "[ <a target=\"_blank\" href=\""+cvsBaseUrl+"/"+package+"/"+subpackage+"\">cvs</a> ]"
00065     return cvsLink

def Association::formatPackageDocumentationLink	(	package,
		subpackage
	)

Definition at line 66 of file Association.py.

00066                                                        :    
00067     for link in packageDocLinks:
00068         if (link.find(package+"_"+subpackage+".html") != -1):
00069             return "[ <a target=\"_blank\" href=\"../"+link+"\">packageDoc</a> ]"
00070     
00071     return ""
00072

def Association::generateBranchHTML	(	SRC_DIR,
		tree,
		branch
	)

Generates HTML for Subsystem.

Definition at line 115 of file Association.py.

00115                                              : 
00116     branchHTML = ""
00117     
00118     for package,subpackages in sorted(tree[branch].items()):
00119         branchHTML += "<li><span><strong>"+package+"</strong></span><ul>"
00120         
00121         for subpackage in subpackages:
00122             branchHTML += "<li>"+subpackage + " "+ formatCVSLink(package, subpackage) + " " + formatPackageDocumentationLink(package, subpackage)
00123             branchHTML += generateLeavesHTML(SRC_DIR, package, subpackage)
00124             branchHTML+="</li>"
00125             
00126         branchHTML +="</ul>"
00127     
00128     branchHTML += "</li>"    
00129     return branchHTML
00130

def Association::generateLeavesHTML	(	SRC_DIR,
		package,
		subpackage
	)

Generates HTML for subpackage.

Definition at line 93 of file Association.py.

00094                                                     :
00095     html = ""
00096     try:
00097         dirList=os.listdir(SRC_DIR + "/" + package+"/"+subpackage+"/interface/")
00098         for classfile in dirList:
00099             if classfile.endswith(".h"):
00100                 classfile = classfile.replace(".h", "")
00101                 for key in refmanfiles.keys():
00102                     if (key.find(classfile) != -1):
00103                         classfile = "<a target=\"_blank\" href=\""+refmanfiles[key]+"\">"+classfile+"</a>"
00104                         break
00105                 
00106                 html += "<li>"+classfile+"</li>"
00107     except:
00108         pass
00109     
00110     if html != "":
00111         html = "<ul>"+html+"</ul>"
00112     
00113     return html

def Association::generateTree ( release )

Fetches information about Subsystems/Packages/Subpackages from TagCollector.

Definition at line 74 of file Association.py.

00075                          :
00076     #data = json.loads(urllib2.urlopen('https://cmstags.cern.ch/tc/CategoriesPackagesJSON?release=' + release).read())
00077     data = parseJSON('/cmsdoxygen/tcproxy.php?type=packages&release=' + release)
00078     
00079     tree = {}
00080     subsystems = sorted(data.keys())
00081     
00082     for subsystem in subsystems:
00083         tree[subsystem] = {}
00084         for packagesub in data[subsystem]:        
00085             (package, subpackage) = packagesub.split("/")
00086             
00087             if not package in tree[subsystem]:
00088                 tree[subsystem][package] = []
00089             tree[subsystem][package].append(subpackage)
00090             
00091     return (tree, subsystems)

def Association::loadTemplates ( )

Read template file.

Definition at line 132 of file Association.py.

00133                    :
00134     templateFile = SCRIPTS_LOCATION+"/indexPage/tree_template.html" 
00135             
00136     fileIN = open(templateFile, "r")
00137     treeTemplateHTML = fileIN.read()
00138     fileIN.close()
00139     
00140     
00141     templateFile = SCRIPTS_LOCATION+"/indexPage/indexpage_template.html"  
00142     fileIN = open(templateFile, "r")
00143     indexPageTemplateHTML = fileIN.read()
00144     fileIN.close()
00145     
00146     
00147     return treeTemplateHTML, indexPageTemplateHTML

def Association::parseJSON ( url )

Definition at line 22 of file Association.py.

00023                   :
00024     ret = {}
00025     
00026     html = os.popen("curl \""+url+"\"")
00027     input = html.read()
00028     html.close()
00029     
00030     input = input.replace("{","").replace("}", "")
00031     collections = input.split("], ")
00032     
00033     for collection in collections:
00034         parts = collection.split(": [")
00035         title = parts[0].replace('"', '')
00036         list = parts[1].replace("]", "").replace('"', '').split(", ")
00037         ret[title] = list
00038     
00039     return ret
00040

def Association::preparePackageDocumentationLinks ( DOC_DIR )

Extract links to package documentation.

Definition at line 52 of file Association.py.

00053                                              :
00054     source = open(DOC_DIR+"/pages.html", "r")
00055     lines = source.read().split("\n")
00056     source.close()
00057     
00058     for line in lines:
00059         if (line.find("li><a class=\"el\" href=\"") != -1):
00060             packageDocLinks.append(line.split("\"")[3])

def Association::prepareRefManFiles ( DOC_DIR )

Prepate dictionary of doxygen generated html files.

Definition at line 42 of file Association.py.

00042                                :    
00043     output = os.popen("find "+DOC_DIR+" -wholename '*/class*.html' -not \( -name '*-members.html' \) -print")
00044     lines = output.read().split("\n")
00045     output.close()
00046     
00047     for line in lines:
00048         (head, tail) = os.path.split(line)
00049         refmanfiles[tail.replace("class","").replace(".html","")] = baseUrl+line[line.find(CMSSW_VERSION):]
00050

Variable Documentation

string Association::baseUrl = "/cmsdoxygen/"

Definition at line 17 of file Association.py.

Association::block = indexPageBlockNoTree

Formating index page's pieces.

Definition at line 232 of file Association.py.

Referenced by BlockWipedAllocator::alloc(), PFRecoTauAlgorithm::buildPFTau(), evf::FUResourceQueue::buildResource(), evf::FUResourceTable::buildResource(), evf::ResourceChecker::checkDataBlockPayload(), evf::BU::createMsgChain(), DTScalerInfoTask::endLuminosityBlock(), PFPhotonAlgo::EvaluateSingleLegMVA(), CalibratableTest::extractCandidate(), DisplayManager::findBlock(), evf::IPCMethod::isLastMessageOfEvent(), HcalPatternSource::loadPatternFile(), gen::ParameterCollector::const_iterator::next(), reco::tau::RecoTauElectronRejectionPlugin::operator()(), PFAlgoTestBenchElectrons::processBlock(), evf::ResourceChecker::processDataBlock(), PFRootEventManagerColin::processHIGH_E_TAUS(), PFAlgo::reconstructParticles(), PFElectronAlgo::SetActive(), PFElectronAlgo::SetCandidates(), PFElectronAlgo::SetIDOutputs(), PFElectronAlgo::SetLinks(), gen::Pythia6Service::setSLHAFromHeader(), Herwig6Hadronizer::setSLHAFromHeader(), and CSCSPRecord::unpack().

tuple Association::branchHTML = generateBranchHTML(SRC_DIR, tree, subsystem)

Generating treeviews.

Definition at line 227 of file Association.py.

list Association::CMSSW_VERSION = sys.argv[1]

Definition at line 152 of file Association.py.

string Association::contacts = ""

Definition at line 238 of file Association.py.

string Association::cvsBaseUrl = "https://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW"

Definition at line 16 of file Association.py.

Association::errorOnImport = False

Definition at line 7 of file Association.py.

tuple Association::fileIN = open(SCRIPTS_LOCATION+"/indexPage/indexpage_warning.html", "r")

Warning page.

Definition at line 174 of file Association.py.

string Association::indexPageBlock

Initial value:

00001 """
00002 <tr class=\"@ROW_CLASS@\">
00003     <td width=\"50%\"><a href=\"#@SUBSYSTEM@\" onclick=\"javascript:getIframe('@SUBSYSTEM@')\">@SUBSYSTEM@</a></td>
00004     <td width=\"50%\" class=\"contact\">@CONTACTS@</td>
00005 </tr>
00006 <tr><td colspan=\"2\"><span id=\"@SUBSYSTEM@\"></span></td></tr>
00007 """

Definition at line 188 of file Association.py.

string Association::indexPageBlockNoTree

Initial value:

00001 """
00002 <tr class=\"@ROW_CLASS@\">
00003     <td width=\"50%\">@SUBSYSTEM@</td>
00004     <td width=\"50%\" class=\"contact\">@CONTACTS@</td>
00005 </tr>
00006 <tr><td colspan=\"2\"><span id=\"@SUBSYSTEM@\"></span></td></tr>
00007 """