'''
netcraft.py

Copyright 2006 Andres Riancho

This file is part of w3af, w3af.sourceforge.net .

w3af is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation version 2 of the License.

w3af is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with w3af; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

'''

import core.controllers.outputManager as om

# options
from core.data.options.option import option
from core.data.options.optionList import optionList

from core.controllers.basePlugin.baseDiscoveryPlugin import baseDiscoveryPlugin
from core.controllers.w3afException import w3afException, w3afRunOnce

import core.data.kb.knowledgeBase as kb
import core.data.kb.info as info

from core.data.parsers.urlParser import url_object

import re

class netcraft(baseDiscoveryPlugin):
    '''
    Find out "What's that site running?".
    
    @author: ino ( guerrino.dimassa@gmail.com )
    '''    
    def __init__(self):
        baseDiscoveryPlugin.__init__(self)

        # Internal variables
        self._exec = True
    
    def discover(self, fuzzableRequest ):
        '''
        Search netcraft and parse the output.
        
        @parameter fuzzableRequest: A fuzzableRequest instance that contains 
                                    (among other things) the site to test.
        '''
        if not self._exec :
            # This will remove the plugin from the discovery plugins to be runned.
            raise w3afRunOnce()
        else:
            # Only run once
            self._exec = False                
            target_domain = fuzzableRequest.getURL().getRootDomain()
            
            # Example URL:
            # http://toolbar.netcraft.com/site_report?url=http://www.foo.org
            #

	    nc_url_str = 'http://toolbar.netcraft.com/site_report?url=' + target_domain
            nc_url = url_object( nc_url_str )

            try:
                response = self._urlOpener.GET( nc_url )
            except w3afException, e:
                msg = 'An exception was raised while running netcraft plugin. Exception: ' + str(e)
                om.out.debug( msg )

	    i = info.info()
            i.setPluginName(self.getName())
            i.setName('Found')
            i.setId( response.getId() )
	    msg = 'The target site was found on Netcraft.For more'
            msg += ' information please go to Response->Rendered.'
            i.setDesc( msg)
                    
            # Save the results in the KB so the user can look at it
            kb.kb.append( self, 'server', i )
                
    def getOptions( self ):
        '''
        @return: A list of option objects for this plugin.
        '''    
        ol = optionList()
        return ol
        
    def setOptions( self, options ):
        '''
        This method sets all the options that are configured using the user interface 
        generated by the framework using the result of getOptions().
        
        @parameter OptionList: A dictionary with the options for the plugin.
        @return: No value is returned.
        ''' 
        pass
        
    def getPluginDeps( self ):
        '''
        @return: A list with the names of the plugins that should be runned before the
        current one.
        '''
        return []

    def getLongDesc( self ):
        return '''
        This plugin searches the netcraft database and parses the result.The information
        stored in that database is useful to know about Netblock Owner,IP address,OS,Web Server,Last changed
        of the site.
        '''