%
% API Documentation
% Module pc_parse
%
% Generated by epydoc 2.1
% [Wed Oct 26 19:48:55 2005]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{pc\_parse \textit{(module)}|(}
\section{Module pc\_parse}

    \label{pc_parse}
module to parse the results of the client script


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               Functions                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsection{Functions}

    \label{pc_parse:getFile_system}
    \index{pc\_parse \textit{(module)}!getFile\_system \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getFile\_system}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the file sytem : a list a dict with the following key : * path 
    the absolu path of the file * size in octet * date second since the 
    begin of computer world

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getFsstat}
    \index{pc\_parse \textit{(module)}!getFsstat \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getFsstat}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getHostname}
    \index{pc\_parse \textit{(module)}!getHostname \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getHostname}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the hostname

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getHotfix}
    \index{pc\_parse \textit{(module)}!getHotfix \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getHotfix}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of the Hotfix for example [('Q147222', '13/02/2005')]

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getInstalldate}
    \index{pc\_parse \textit{(module)}!getInstalldate \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getInstalldate}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the install date of the os

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getIp_mask}
    \index{pc\_parse \textit{(module)}!getIp\_mask \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getIp\_mask}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of the paar (ip,netmask)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getMac_addr}
    \index{pc\_parse \textit{(module)}!getMac\_addr \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getMac\_addr}(\textit{indiv\_collec}, \textit{ip}, \textit{mask})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the mac address wich correspond to the pair (ip,mask)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getMemory}
    \index{pc\_parse \textit{(module)}!getMemory \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getMemory}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the memory quantity (unit include)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getOs}
    \index{pc\_parse \textit{(module)}!getOs \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getOs}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the kernel version of the os

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getOstype}
    \index{pc\_parse \textit{(module)}!getOstype \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getOstype}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the type os

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getPartition}
    \index{pc\_parse \textit{(module)}!getPartition \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getPartition}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of partition

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getProcess}
    \index{pc\_parse \textit{(module)}!getProcess \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getProcess}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of the running process

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getProcessor_speed}
    \index{pc\_parse \textit{(module)}!getProcessor\_speed \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getProcessor\_speed}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the speed of the processor (unit include)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getProcessor_type}
    \index{pc\_parse \textit{(module)}!getProcessor\_type \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getProcessor\_type}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the type of processor

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getProg}
    \index{pc\_parse \textit{(module)}!getProg \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getProg}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of the installed prog

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getServicepack}
    \index{pc\_parse \textit{(module)}!getServicepack \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getServicepack}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the service pack (windows only)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getShare}
    \index{pc\_parse \textit{(module)}!getShare \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getShare}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of share : something like 
    [(partage,repertoire,remarque)]

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getSuffix_dns}
    \index{pc\_parse \textit{(module)}!getSuffix\_dns \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getSuffix\_dns}(\textit{indiv\_collec}, \textit{ip}, \textit{mask})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the suffix\_dns which correspond to the paar (ip,mask)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getTime}
    \index{pc\_parse \textit{(module)}!getTime \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getTime}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return time (nb second since the beginning of the world :)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getType}
    \index{pc\_parse \textit{(module)}!getType \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getType}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the type (Windows or UNIX)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getUserlist}
    \index{pc\_parse \textit{(module)}!getUserlist \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getUserlist}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the dict of user for example \{'Administrateur': 'lastaccess': 
    '2/13/2005', 'lastchg': '4/23/1990', 'actif': True, 'groups': 
    ['Administrateurs'], 'Invit': 'lastaccess': '8/19/2005', 'lastchg': 
    '7/18/2005', 'actif': True, 'groups': ['csdcsd', 'Invits']\}

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getWindowsversion}
    \index{pc\_parse \textit{(module)}!getWindowsversion \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getWindowsversion}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the version os

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getWinVer}
    \index{pc\_parse \textit{(module)}!getWinVer \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getWinVer}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the result of the command ver (Windows only)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:getWorkgroup}
    \index{pc\_parse \textit{(module)}!getWorkgroup \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{getWorkgroup}(\textit{indiv\_collec})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the workgroup

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsedate_format}
    \index{pc\_parse \textit{(module)}!parsedate\_format \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsedate\_format}(\textit{dir\_cmd})

    \end{boxedminipage}

    \label{pc_parse:parsedir_win}
    \index{pc\_parse \textit{(module)}!parsedir\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsedir\_win}(\textit{result\_cmd}, \textit{date\_format})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of the command dir (Windows only) and return the 
    list of dict (a dict for each file)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parseglobal}
    \index{pc\_parse \textit{(module)}!parseglobal \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parseglobal}(\textit{path})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    convert the script file into a dict which contain for each key (name 
    of command) the result of this commande

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsehostname}
    \index{pc\_parse \textit{(module)}!parsehostname \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsehostname}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of the hostname command and return the hostame

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parseipconfig_win}
    \index{pc\_parse \textit{(module)}!parseipconfig\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parseipconfig\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of ipconfig return a list of dict (a dict for each 
    interface) the keys of this dict are 
    name,ip,gateway,dhcp,mac,netmask,connected,suffix\_dns

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsenetconfig_win}
    \index{pc\_parse \textit{(module)}!parsenetconfig\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsenetconfig\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of net config and return a dict The only one key is 
    workgroup

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsenetshare_win}
    \index{pc\_parse \textit{(module)}!parsenetshare\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsenetshare\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of the command net share and return a list of 
    (partage,repertoire,remarque)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsenetuser_win}
    \index{pc\_parse \textit{(module)}!parsenetuser\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsenetuser\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of netuser and return a dict. The keys are the name 
    of the user

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parseping_win}
    \index{pc\_parse \textit{(module)}!parseping\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parseping\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    Parse ping and return a bool which say if we can contact google

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsepsinfo_win}
    \index{pc\_parse \textit{(module)}!parsepsinfo\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsepsinfo\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of the command psinfo and return and dict. the keys 
    of the dict are : Kernel version,Product type,Product version,Service 
    pack,Kernel build number,Install date,System 
    root,Processors,Processor speed,Processor type,Physical 
    memory,volume,Hotfix et prog

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsepslist_win}
    \index{pc\_parse \textit{(module)}!parsepslist\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsepslist\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of pslist and return

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parseroute_win}
    \index{pc\_parse \textit{(module)}!parseroute\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parseroute\_win}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of the route commande and return the paar 
    (route,default\_gateway) where route is a list of 
    (net\_dest,net\_mask,gateway,interface)

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsetime_win}
    \index{pc\_parse \textit{(module)}!parsetime\_win \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsetime\_win}(\textit{result\_cmd}, \textit{date\_format})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the two following command et return the elapse seconds since 
    the 1970 echo \%time\% echo \%date\%

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parsever}
    \index{pc\_parse \textit{(module)}!parsever \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parsever}(\textit{result\_cmd})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    parse the result of the command ver

    \vspace{1ex}

    \end{boxedminipage}

    \index{pc\_parse \textit{(module)}!parse \textit{(class)}|(}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{Class parse}

    \label{pc_parse:parse}
class written to parse the result of the client scripts


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \label{pc_parse:parse:__init__}
    \index{pc\_parse \textit{(module)}!parse \textit{(class)}!\_\_init\_\_ \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{scans\_client})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    Structure initialisation

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parse:filter_mac}
    \index{pc\_parse \textit{(module)}!parse \textit{(class)}!filter\_mac \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{filter\_mac}(\textit{self}, \textit{mac})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the parsed script which have the mac address mac

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parse:filter_type}
    \index{pc\_parse \textit{(module)}!parse \textit{(class)}!filter\_type \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{filter\_type}(\textit{self}, \textit{type})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of the parsed script with the type type

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parse:list_collec}
    \index{pc\_parse \textit{(module)}!parse \textit{(class)}!list\_collec \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{list\_collec}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the list of the parsed client script result

    \vspace{1ex}

    \end{boxedminipage}

    \label{pc_parse:parse:run_parse}
    \index{pc\_parse \textit{(module)}!parse \textit{(class)}!run\_parse \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{run\_parse}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    to begin to parse

    \vspace{1ex}

    \end{boxedminipage}

    \index{pc\_parse \textit{(module)}!parse \textit{(class)}|)}
    \index{pc\_parse \textit{(module)}|)}