/usr/share/pyshared/qm/attachment.py is in qmtest 2.4.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 | ########################################################################
#
# File: attachment.py
# Author: Alex Samuel
# Date: 2001-03-21
#
# Contents:
# Generic code for handling arbitrary file attachments.
#
# Copyright (c) 2001, 2002, 2003 by CodeSourcery, LLC. All rights reserved.
#
# For license terms see the file COPYING.
#
########################################################################
"""Code for handling arbitrary file attachments.
'Attachment' is a base class for classes that represent arbitrary
attachments. Each 'Attachment' object has these four attributes:
'mime_type' -- The MIME type of the attachment contents. This
information enables user interfaces to handle attachment data in a
sensible fasion.
'description' -- The user's description of the attachment contents.
'file_name' -- A file name associated with the description. This is
usually the name of the file from which the attachment was originally
uploaded or inserted.
'location' -- A string containing the external location of the
attachment data. The semantics of this string are defined by
implementations of 'AttachmentStore', which use it to locate the
attachment's data.
A special 'TemporaryAttachmentStore', with a different interface, is
used to store attachment data temporarily, at most for the life of the
program. The 'temporary_store' global instance should be used."""
########################################################################
# imports
########################################################################
import common
import mimetypes
import os
import xmlutil
import temporary_directory
########################################################################
# classes
########################################################################
class Attachment:
"""An arbitrary file attachment.
Conceptually, an attachment is composed of these parts:
1. A MIME type, as a string.
2. A description, as a structured text string.
3. A file name, corresponding to the original name of the file from
which the attachment was uploaded, or the name of the file to
use when the attachment is presented to the user in a file
system.
4. A block of arbitrary data.
For efficiency reasons, the attachment data is not stored in the
attachment. Instead, a *location* is stored, which is a key into
the associated 'AttachmentStore' object."""
def __init__(self,
mime_type,
description,
file_name,
location,
store):
"""Create a new attachment.
'mime_type' -- The MIME type. If 'None' or an empty string, the
function attempts to guess the MIME type from other information.
'description' -- A description of the attachment contents.
'file_name' -- The user-visible file name to associate the
attachment.
'location' -- The location in an attachment store at which to
find the attachment data.
'store' -- The attachment store in which the data is stored."""
# If no MIME type is specified, try to guess it from the file
# name.
if mime_type == "" or mime_type is None:
mime_type = mimetypes.guess_type(file_name)[0]
if mime_type is None:
# Couldn't guess from the file name. Use a safe
# default.
mime_type = "application/octet-stream"
self.__mime_type = mime_type
# Store other attributes.
self.__description = description
self.__file_name = file_name
self.__location = location
self.__store = store
def GetMimeType(self):
"""Return the attachment's MIME type."""
return self.__mime_type
def GetDescription(self):
"""Return the attachment's description."""
return self.__description
def GetFileName(self):
"""Return the attachment's file name."""
return self.__file_name
def GetLocation(self):
"""Return the attachment's location in an attachment store."""
return self.__location
def GetData(self):
"""Get attachment data.
returns -- The attachment data."""
return self.GetStore().GetData(self.GetLocation())
def GetDataFile(self):
"""Return the path to a file containing attachment data.
returns -- A file system path. The file should be considered
read-only, and should not be modified in any way."""
return self.GetStore().GetDataFile(self.GetLocation())
def GetStore(self):
"""Return the store in which this attachment is located.
returns -- The 'AttachmentStore' that contains this attachment."""
return self.__store
def Move(self, store, location):
"""Move the 'Attachment' to a new location.
'store' -- The 'AttachmentStore' that will contain the
attachment.
'location' -- The location of the attachment within its current
store."""
# Store this attachment in its new location. That must be done
# before removing it from its current location as that step will
# destroy the data contained in the attachment.
store.Store(self, location)
# Now, remove the attachment from its current location.
self.__store.Remove(self.__location)
# Finally, update the information associated with the attachment.
self.__store = store
self.__location = location
def __str__(self):
return '<Attachment "%s" (%s)>' \
% (self.GetDescription(), self.GetMimeType())
def __cmp__(self, other):
return other is None \
or self.GetDescription() != other.GetDescription() \
or self.GetMimeType() != other.GetMimeType() \
or self.GetFileName() != other.GetFileName() \
or self.GetLocation() != other.GetLocation() \
or self.GetStore() != other.GetStore()
class AttachmentStore(object):
"""Interface for classes which store attachment data.
An attachment store stores the raw data for an attachment. The
store is not responsible for storing auxiliary information,
including the attachment's description, file name, or MIME type.
Users of an 'AttachmentStore' reference attachment data by a
*location*, which is stored with the attachment.
Please note that the 'AttachmentStore' interface provides methods
for retrieving attachment data only; not for storing it. The
interface for storing may be defined in any way by implementations."""
def GetData(self, location):
"""Return the data for an attachment.
returns -- A string containing the attachment data."""
raise NotImplementedError
def GetDataFile(self, location):
"""Return the path to a file containing the data for
'attachment'.
returns -- A file system path.
The file is read-only, and may be a temporary file. The caller
should not modify the file in any way."""
raise NotImplementedError
def GetSize(self, location):
"""Return the size of the data for an attachment.
returns -- The length of the attachment data, in bytes.
This method may be overridden by derived classes."""
return len(self.GetData(location))
def HandleDownloadRequest(self, request):
"""Handle a web request to download attachment data.
'request' -- A 'WebRequest' object. The location of the
attachment data is stored in the 'location' property, and the
MIME type in the 'mime_type' property.
returns -- A pair '(mime_type, data)' where 'mime_type' is the
MIME type stored in the request and 'data' is the contents of
the attachment."""
location = request["location"]
mime_type = request["mime_type"]
data = self.GetData(location)
return (mime_type, data)
def Store(self, attachment, location):
"""Add an attachment to the store.
'attachment' -- The 'Attachment' to store.
'location' -- The location in which to store the 'attachment'."""
raise NotImplementedError
class FileAttachmentStore(AttachmentStore):
"""An attachment store based on the file system.
The locations are the names of files in the file system."""
def __init__(self, root = None):
"""Construct a new 'FileAttachmentStore'
'root' -- If not 'None', the root directory for the store. All
locations are relative to this directory. If 'None', all
locations are relative to the current directory."""
super(AttachmentStore, self).__init__()
self.__root = root
def GetData(self, location):
# Open the file.
f = open(self.GetDataFile(location))
# Read the contents.
s = f.read()
# Close the file.
f.close()
return s
def GetDataFile(self, location):
if self.__root is not None:
# It might seem sensible to assert that the location be a
# relative path, but that would break backwards
# compatibility with older versions fo QMTest. In those
# older versions, the XMLDatabase sometimes used an absolute
# path for attachment locations.
return os.path.join(self.__root, location)
else:
return location
def GetSize(self, location):
return os.stat(self.GetDataFile(location))[6]
def Store(self, attachment, location):
# Create the file.
file = open(self.GetDataFile(location), "w")
# Write the data.
file.write(attachment.GetData())
# Close the file.
file.close()
def Remove(self, location):
"""Remove an attachment.
'location' -- The location whose data should be removed."""
os.remove(self.GetDataFile(location))
class TemporaryAttachmentStore(FileAttachmentStore):
"""Temporary storage for attachment data.
A 'TemporaryAttachmentStore' stores attachment data in a temporary
location, for up to the lifetime of the running program. When the
program ends, all temporarily stored attachment data is deleted.
A data object in the temporary store is identified by its location.
Locations should be generated by 'make_temporary_location'."""
def __init__(self):
"""Construct a temporary attachment store.
The store is initially empty."""
# Construct a temporary directory in which to store attachment
# data.
self.__tmpdir = temporary_directory.TemporaryDirectory()
# Initialize the base class.
path = self.__tmpdir.GetPath()
super(TemporaryAttachmentStore, self).__init__(path)
def HandleUploadRequest(self, request):
"""Handle a web request to upload attachment data.
Store the attachment data contained in the request as a
temporary attachment. It is assumed that the request is being
submitted from a popup upload browser window, so the returned
HTML page instructs the window to close itself.
'request' -- A 'WebRequest' object.
returns -- HTML text of a page that instructs the browser window
to close."""
location = request["location"]
# Create the file.
file = open(self.GetDataFile(location), "w")
# Write the data.
file.write(request["file_data"])
# Close the file.
file.close()
# Return a page that closes the popup window from which the
# attachment was submitted.
return '''
<html><body>
<script type="text/javascript" language="JavaScript">
window.close();
</script>
</body></html>
'''
########################################################################
# functions
########################################################################
_temporary_location_prefix = "_temporary"
def make_temporary_location():
"""Return a unique location for temporary attachment data."""
return _temporary_location_prefix + common.make_unique_tag()
def make_dom_node(attachment, document):
"""Create a DOM element node for this attachment.
'document' -- A DOM document node in which to create the
element.
returns -- A DOM element node."""
# Create an attachment element.
node = document.createElement("attachment")
# Is it a null attachment?
if attachment is None:
# Then that's it.
return node
mime_type = attachment.GetMimeType()
# Create and add the description node.
child = xmlutil.create_dom_text_element(
document, "description", attachment.GetDescription())
node.appendChild(child)
# Create and add the MIME type node.
child = xmlutil.create_dom_text_element(
document, "mime-type", mime_type)
node.appendChild(child)
# Create and add the file name node.
child = xmlutil.create_dom_text_element(
document, "filename", attachment.GetFileName())
node.appendChild(child)
# Create a location element, to include attachment data by
# reference.
location = attachment.GetLocation()
child = xmlutil.create_dom_text_element(document, "location", location)
node.appendChild(child)
return node
def from_dom_node(node, store):
"""Construct an attachment object from a DOM element node.
'node' -- A DOM attachment element node.
'store' -- The associated attachment store.
returns -- An attachment instance. The type is determined by
'attachment_class'.
If the attachment object requires additional context information to
interpret the location (if it's specified in the attachment
element), the caller must provide it directly to the object."""
if len(node.childNodes) == 0:
# It's an empty element, signifying a null attachment.
return None
# Extract the fixed fields; use a default value for each that is not
# present.
description = xmlutil.get_child_text(node, "description", "")
mime_type = xmlutil.get_child_text(
node, "mime-type", "application/octet-stream")
file_name = xmlutil.get_child_text(node, "filename", "")
location = xmlutil.get_child_text(node, "location")
# Construct the resulting attachment.
return Attachment(mime_type, description, file_name, location, store)
########################################################################
# Local Variables:
# mode: python
# indent-tabs-mode: nil
# fill-column: 72
# End:
|