import repository from arizona
[raven.git] / lib / arizona-lib / transfer / arizonatransfer_https.py
1 #! /usr/bin/env python
2 """
3 Stork Project (http://www.cs.arizona.edu/stork/)
4 Module: arizonatransfer_https
5 Description:   Provides a general file transferring by HTTPS
6                This is essentially a stub module that calls arizonatransfer_http
7
8 """
9
10 import urllib
11 import urllib2
12 import os
13 import time
14 import arizonareport
15 import arizonatransfer_http
16
17
18
19
20 def close_transfer_program():
21    """
22    <Purpose>
23       This closes a connection (dummy function for HTTP).
24
25    <Arguments>
26       None.
27
28    <Exceptions>
29       None.
30
31    <Side Effects>
32       None.
33
34    <Returns>
35       True.
36    """
37
38    return arizonatransfer_http.close_transfer_program()
39
40
41
42 def init_transfer_program(ignore=None, ignore2=None, ignore3=None, ignore4=None):
43    """
44    <Purpose>
45       This initializes a connection (dummy function for HTTP).
46
47    <Arguments>
48       None.
49
50    <Exceptions>
51       None.
52
53    <Side Effects>
54       None.
55
56    <Returns>
57       True.
58    """
59    return arizonatransfer_http.init_transfer_program(ignore, ignore2, ignore3, ignore4)
60
61
62
63
64 def retrieve_files(host, filelist, destdir='.', indicator=None):
65    """
66    <Purpose>
67       This retrieves files from a host to a destdir.
68
69    <Arguments>
70       host:
71          'host' holds two things, a server name and target directory.
72          For example, if you want to retrieve files from '/tmp/' directory
73          in 'quadrus.cs.arizona.edu' server, the 'host' will be
74          'quadrus.cs.arizona.edu/tmp'.
75
76       filelist:
77          'filelist' is a list of files which need to be retrieved.
78
79       destdir:
80          'destdir' is a destination directory where retrieved files will
81          be placed. A user should have 'destdir' exist before retrieving
82          files. 'destdir' should be a string. Default is a current dir.
83
84       indicator:
85          'indicator' is a module which has set_filename and
86          download_indicator functions. 'indicator' will be passed in
87          'urlretrieve' function so that progress bar will be shown
88          while downloading files. Default is 'None'.
89
90    <Exceptions>
91       None.
92
93    <Side Effects>
94       None.
95
96    <Returns>
97       (True, grabbed_list)
98       'grabbed_list' is a list of files which are retrieved
99    """
100    # call arizonatransfer to download the file, specifying the "https"
101    # protocol to ensure a secure connection is used.
102    return arizonatransfer_http.retrieve_files(host, filelist, destdir, indicator, "https")
103
104
105
106
107 def transfer_name():
108    """
109    <Purpose>
110       This gives the name of this transfer method.
111
112    <Arguments>
113       None.
114
115    <Exceptions>
116       None.
117
118    <Side Effects>
119       None.
120
121    <Returns>
122       'arizona_http' as an string
123    """
124
125    return 'arizona_https'
126