WebKit.UnknownFileTypeServlet | index /usr/local/share/webware/WebKit/UnknownFileTypeServlet.py

Modules

``

WebKit.HTTPExceptions | mimetypes | os | time

Classes

``

MiscUtils.Configurable.Configurable
  UnknownFileTypeServlet(WebKit.HTTPServlet.HTTPServlet, MiscUtils.Configurable.Configurable)
WebKit.HTTPServlet.HTTPServlet(WebKit.Servlet.Servlet)
  UnknownFileTypeServlet(WebKit.HTTPServlet.HTTPServlet, MiscUtils.Configurable.Configurable)
WebKit.ServletFactory.ServletFactory(WebKit.Object.Object)
  UnknownFileTypeServletFactory

class UnknownFileTypeServlet(WebKit.HTTPServlet.HTTPServlet, MiscUtils.Configurable.Configurable)

``

`Servlet for unknown file types.
Normally this class is just a "private" utility class for WebKit's
purposes. However, you may find it useful to subclass on occasion,
such as when the server side file path is determined by something
other than a direct correlation to the URL. Here is such an example:
from WebKit.AppServer import globalAppServer
from WebKit.UnknownFileTypeServlet import UnknownFileTypeServlet
import os
class Image(UnknownFileTypeServlet):
imageDir = '/var/images'
def filename(self, trans):
filename = trans.request().field('i')
filename = os.path.join(self.imageDir, filename)
return filename
`

Method resolution order:
  UnknownFileTypeServlet
  WebKit.HTTPServlet.HTTPServlet
  WebKit.Servlet.Servlet
  WebKit.Object.Object
  __builtin__.object
  MiscUtils.NamedValueAccess.NamedValueAccess
  MiscUtils.Configurable.Configurable

Methods defined here:

__init__(self, application=None)

canBeReused(self)

configFilename(self)

filename(self, trans)
  `Return the filename to be served.
  A subclass could override this in order to serve files from other
  disk locations based on some logic.`

lastModified(self, trans)

redirectSansAdapter(self, trans)
  `Redirect to web server.
  Sends a redirect to a URL that doesn't contain the adapter name.
  Under the right configuration, this will cause the web server to
  then be responsible for the URL rather than the app server.
  This has only been test with "*.[f]cgi" adapters.
  Keep in mind that links off the target page will *not* include
  the adapter in the URL.`

respondToGet(self, trans)
  `Respond to GET request.
  Responds to the transaction by invoking foo() for foo is
  specified by the 'Technique' setting.`

respondToHead = respondToGet(self, trans)

respondToPost(self, trans)
  `Respond to POST request.
  Invoke respondToGet().
  Since posts are usually accompanied by data, this might not be
  the best policy. However, a POST would most likely be for a CGI,
  which currently no one is mixing in with their WebKit-based web sites.`

serveContent(self, trans)

shouldCacheContent(self)
  `Return whether the content should be cached or not.
  Returns a boolean that controls whether or not the content served
  through this servlet is cached. The default behavior is to return
  the CacheContent setting. Subclasses may override to always True
  or False, or incorporate some other logic.`

userConfig(self)
  `Get the user config.
  This is taken from the 'UnknownFileTypes' section
  in the Application's configuration.`

validTechniques(self)

Methods inherited from WebKit.HTTPServlet.HTTPServlet:

notImplemented(self, trans)

respond(self, trans)
  `Respond to a request.
  Invokes the appropriate respondToSomething() method depending on the
  type of request (e.g., GET, POST, PUT, ...).`

Methods inherited from WebKit.Servlet.Servlet:

awake(self, trans)
  `Send the awake message.
  This message is sent to all objects that participate in the
  request-response cycle in a top-down fashion, prior to respond().
  Subclasses must invoke super.`

canBeThreaded(self)
  `Return whether the servlet can be multithreaded.
  This value should not change during the lifetime of the object.
  The default implementation returns False.
  Note: This is not currently used.`

close(self, trans)

log(self, message)
  `Log a message.
  This can be invoked to print messages concerning the servlet.
  This is often used by self to relay important information back
  to developers.`

name(self)
  `Return the name which is simple the name of the class.
  Subclasses should *not* override this method.
  It is used for logging and debugging.`

runMethodForTransaction(self, trans, method, *args, **kw)

runTransaction(self, trans)

serverSidePath(self, path=None)
  `Return the filesystem path of the page on the server.`

setFactory(self, factory)

sleep(self, trans)
  `Send the sleep message.`

Methods inherited from WebKit.Object.Object:

deprecated(self, method)
  `Output a deprecation warning.
  The implementation of WebKit sometimes invokes this method which prints
  a warning that the method you are using has been deprecated.
  This method expects that deprecated methods say so at the beginning of
  their doc string and terminate that msg with @. For example:
  DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @
  Putting this information in the doc string is important for accuracy
  in the generated docs.
  Example call:
  deprecated(self.foo)`

Data and other attributes inherited from WebKit.Object.Object:

__dict__ = <dictproxy object>
  `dictionary for instance variables (if defined)`

__weakref__ = <attribute '__weakref__' of 'Object' objects>
  `list of weak references to the object (if defined)`

Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:

hasValueForKey(self, key)
  `Returns true if the key is available, although that does not
  guarantee that there will not be errors caused by retrieving the key.`

hasValueForName(self, keysString)

resetKeyBindings(self)

setValueForKey(self, key, value)
  `Suppose key is 'foo'. This method sets the value with the following precedence:
  1. Public attributes before private attributes
  2. Methods before non-methods
  More specifically, this method then uses one of the following:
  @@ 2000-03-04 ce: fill in
  ...or invokes handleUnknownSetKey().`

valueForKey(self, key, default=<class MiscUtils.NoDefault>)
  `Suppose key is 'foo'. This method returns the value with the following precedence:
  1. Methods before non-methods
  2. Public attributes before private attributes
  More specifically, this method then returns one of the following:
  * foo()
  * _foo()
  * self.foo
  * self._foo
  ...or default, if it was specified,
  otherwise invokes and returns result of valueForUnknownKey().
  Note that valueForUnknownKey(), normally returns an exception.
  See valueForName() which is a more advanced version of this method that allows
  multiple, qualified keys.`

valueForKeySequence(self, listOfKeys, default=None)

valueForName(self, keysString, default=None)
  `Returns the value for the given keysString. This is the more advanced version of
  valueForKey(), which can only handle single names. This method can handle
  'foo', 'foo1.foo2', 'a.b.c.d', etc. It will traverse dictionaries if needed.`

valueForUnknownKey(self, key, default)
  `# Errors`

valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
  `Returns a list of values that match the given keys, each of which is passed
  through valueForName() and so could be of the form 'a.b.c'.
  keys is a sequence. default is any kind of object. defaults is a sequence.
  forgive and includeNames is a flag.
  If default is not None, then it is substituted when a key is not found.
  Otherwise, if defaults is not None, then it's corresponding/parallel value
  for the current key is substituted when a key is not found.
  Otherwise, if forgive=1, then unknown keys simply don't produce any values.
  Otherwise, if default and defaults are None, and forgive=0, then the unknown
  keys will probably raise an exception through valueForUnknownKey() although
  that method can always return a final, default value.
  if keys is None, then None is returned. If keys is an empty list, then None
  is returned.
  Often these last four arguments are specified by key.
  Examples:
  names = ['origin.x', 'origin.y', 'size.width', 'size.height']
  obj.valuesForNames(names)
  obj.valuesForNames(names, default=0.0)
  obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
  obj.valuesForNames(names, forgive=0)
  @@ 2000-03-04 ce: includeNames is only supported when forgive=1.
  It should be supported for the other cases.
  It should be documented.
  It should be included in the test cases.`

Methods inherited from MiscUtils.Configurable.Configurable:

commandLineConfig(self)
  `Settings that came from the command line (via
  addCommandLineSetting).`

config(self)
  `Returns the configuration of the object as a dictionary. This is a combination of defaultConfig() and userConfig(). This method caches the config.`

configName(self)
  `Returns the name of the configuration file (the portion
  before the '.config'). This is used on the command-line.`

configReplacementValues(self)
  `Returns a dictionary suitable for use with "string % dict"
  that should be used on the text in the config file. If an
  empty dictionary (or None) is returned then no substitution
  will be attempted.`

defaultConfig(self)
  `Returns a dictionary containing all the default values for the settings. This implementation returns {}. Subclasses should override.`

hasSetting(self, name)

printConfig(self, dest=None)
  `Prints the configuration to the given destination, which defaults to stdout. A fixed with font is assumed for aligning the values to start at the same column.`

setSetting(self, name, value)

setting(self, name, default=<class MiscUtils.NoDefault>)
  `Returns the value of a particular setting in the configuration.`

class UnknownFileTypeServletFactory(WebKit.ServletFactory.ServletFactory)
`` | `The servlet factory for unknown file types. I.e. all files other than .py, .psp, .kid and the other types we support.`

Method resolution order:
  UnknownFileTypeServletFactory
  WebKit.ServletFactory.ServletFactory
  WebKit.Object.Object
  __builtin__.object
  MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:

extensions(self)

flushCache(self)

servletForTransaction(self, transaction)

uniqueness(self)

Methods inherited from WebKit.ServletFactory.ServletFactory:

__init__(self, application)
  `Create servlet factory.
  Stores a reference to the application in self._app, because
  subclasses may or may not need to talk back to the application
  to do their work.`

importAsPackage(self, transaction, serverSidePathToImport)
  `Import requested module.
  Imports the module at the given path in the proper package/subpackage
  for the current request. For example, if the transaction has the URL
  http://localhost/WebKit.cgi/MyContextDirectory/MySubdirectory/MyPage
  and path = 'some/random/path/MyModule.py' and the context is configured
  to have the name 'MyContext' then this function imports the module at
  that path as MyContext.MySubdirectory.MyModule . Note that the context
  name may differ from the name of the directory containing the context,
  even though they are usually the same by convention.
  Note that the module imported may have a different name from the
  servlet name specified in the URL. This is used in PSP.`

loadClass(self, transaction, path)
  `Load the appropriate class.
  Given a transaction and a path, load the class for creating these
  servlets. Caching, pooling, and threadsafeness are all handled by
  servletForTransaction. This method is not expected to be threadsafe.`

name(self)
  `Return the name of the factory.
  This is a convenience for the class name.`

returnServlet(self, trans, servlet)
  `Return servlet to the pool.
  Called by Servlet.close(), which returns the servlet
  to the servlet pool if necessary.`

Methods inherited from WebKit.Object.Object:

deprecated(self, method)
  `Output a deprecation warning.
  The implementation of WebKit sometimes invokes this method which prints
  a warning that the method you are using has been deprecated.
  This method expects that deprecated methods say so at the beginning of
  their doc string and terminate that msg with @. For example:
  DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @
  Putting this information in the doc string is important for accuracy
  in the generated docs.
  Example call:
  deprecated(self.foo)`

Data and other attributes inherited from WebKit.Object.Object:

__dict__ = <dictproxy object>
  `dictionary for instance variables (if defined)`

__weakref__ = <attribute '__weakref__' of 'Object' objects>
  `list of weak references to the object (if defined)`

Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:

hasValueForKey(self, key)
  `Returns true if the key is available, although that does not
  guarantee that there will not be errors caused by retrieving the key.`

hasValueForName(self, keysString)

resetKeyBindings(self)

setValueForKey(self, key, value)
  `Suppose key is 'foo'. This method sets the value with the following precedence:
  1. Public attributes before private attributes
  2. Methods before non-methods
  More specifically, this method then uses one of the following:
  @@ 2000-03-04 ce: fill in
  ...or invokes handleUnknownSetKey().`

valueForKey(self, key, default=<class MiscUtils.NoDefault>)
  `Suppose key is 'foo'. This method returns the value with the following precedence:
  1. Methods before non-methods
  2. Public attributes before private attributes
  More specifically, this method then returns one of the following:
  * foo()
  * _foo()
  * self.foo
  * self._foo
  ...or default, if it was specified,
  otherwise invokes and returns result of valueForUnknownKey().
  Note that valueForUnknownKey(), normally returns an exception.
  See valueForName() which is a more advanced version of this method that allows
  multiple, qualified keys.`

valueForKeySequence(self, listOfKeys, default=None)

valueForName(self, keysString, default=None)
  `Returns the value for the given keysString. This is the more advanced version of
  valueForKey(), which can only handle single names. This method can handle
  'foo', 'foo1.foo2', 'a.b.c.d', etc. It will traverse dictionaries if needed.`

valueForUnknownKey(self, key, default)
  `# Errors`

valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
  `Returns a list of values that match the given keys, each of which is passed
  through valueForName() and so could be of the form 'a.b.c'.
  keys is a sequence. default is any kind of object. defaults is a sequence.
  forgive and includeNames is a flag.
  If default is not None, then it is substituted when a key is not found.
  Otherwise, if defaults is not None, then it's corresponding/parallel value
  for the current key is substituted when a key is not found.
  Otherwise, if forgive=1, then unknown keys simply don't produce any values.
  Otherwise, if default and defaults are None, and forgive=0, then the unknown
  keys will probably raise an exception through valueForUnknownKey() although
  that method can always return a final, default value.
  if keys is None, then None is returned. If keys is an empty list, then None
  is returned.
  Often these last four arguments are specified by key.
  Examples:
  names = ['origin.x', 'origin.y', 'size.width', 'size.height']
  obj.valuesForNames(names)
  obj.valuesForNames(names, default=0.0)
  obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
  obj.valuesForNames(names, forgive=0)
  @@ 2000-03-04 ce: includeNames is only supported when forgive=1.
  It should be supported for the other cases.
  It should be documented.
  It should be included in the test cases.`

Data
`` |  | debug = 0 fileCache = {}