blob: 8337f2d72dffaabf5954176ba09d272d91322a1e [file] [log] [blame]
Jack Jansen4b76ba31997-01-09 16:26:23 +00001"""IC wrapper module, based on Internet Config 1.3"""
2
Benjamin Peterson23681932008-05-12 21:42:13 +00003from warnings import warnpy3k
Benjamin Petersona6864e02008-07-14 17:42:17 +00004warnpy3k("In 3.x, the ic module is removed.", stacklevel=2)
Benjamin Peterson23681932008-05-12 21:42:13 +00005
Jack Jansen4b76ba31997-01-09 16:26:23 +00006import icglue
7import string
8import sys
Jack Jansencf0b2e82003-02-05 15:49:19 +00009import os
Jack Jansen5a6fdcd2001-08-25 12:15:04 +000010from Carbon import Res
Jack Jansencf0b2e82003-02-05 15:49:19 +000011import Carbon.File
Jack Jansen4b76ba31997-01-09 16:26:23 +000012import macostools
13
14error=icglue.error
15
16# From ictypes.h:
Jack Jansen0ae32202003-04-09 13:25:43 +000017icPrefNotFoundErr = -666 # preference not found (duh!)
18icPermErr = -667 # cannot set preference
19icPrefDataErr = -668 # problem with preference data
20icInternalErr = -669 # hmm, this is not good
21icTruncatedErr = -670 # more data was present than was returned
22icNoMoreWritersErr = -671 # you cannot begin a write session because someone else is already doing it */
23icNothingToOverrideErr = -672 # no component for the override component to capture
24icNoURLErr = -673 # no URL found
25icConfigNotFoundErr = -674 # no configuration was found
26icConfigInappropriateErr = -675 # incorrect manufacturer code
Jack Jansen4b76ba31997-01-09 16:26:23 +000027
28ICattr_no_change = -1
29
30icNoPerm = 0
31icReadOnlyPerm = 1
32icReadWritePerm = 2
33# End of ictypes.h
34
Jack Jansen8dc797d1997-01-10 15:25:47 +000035class ICOpaqueData:
Jack Jansen0ae32202003-04-09 13:25:43 +000036 """An unparseable IC entry"""
37 def __init__(self, data):
38 self.data = data
Jack Jansen8dc797d1997-01-10 15:25:47 +000039
Jack Jansen0ae32202003-04-09 13:25:43 +000040 def __repr__(self):
Walter Dörwald70a6b492004-02-12 17:35:32 +000041 return "ICOpaqueData(%r)"%(self.data,)
Jack Jansen8dc797d1997-01-10 15:25:47 +000042
43_ICOpaqueDataType=type(ICOpaqueData(''))
Tim Peters182b5ac2004-07-18 06:16:08 +000044
Jack Jansen4b76ba31997-01-09 16:26:23 +000045def _decode_default(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000046 if len(data) == 0:
47 return data
48 if ord(data[0]) == len(data)-1:
49 # Assume Pstring
50 return data[1:]
51 return ICOpaqueData(data)
Tim Peters182b5ac2004-07-18 06:16:08 +000052
53
Jack Jansen4b76ba31997-01-09 16:26:23 +000054def _decode_multistr(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000055 numstr = ord(data[0]) << 8 | ord(data[1])
56 rv = []
57 ptr = 2
58 for i in range(numstr):
59 strlen = ord(data[ptr])
60 str = data[ptr+1:ptr+strlen+1]
61 rv.append(str)
62 ptr = ptr + strlen + 1
63 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +000064
Jack Jansen4b76ba31997-01-09 16:26:23 +000065def _decode_fontrecord(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000066 size = ord(data[0]) << 8 | ord(data[1])
67 face = ord(data[2])
68 namelen = ord(data[4])
69 return size, face, data[5:5+namelen]
Tim Peters182b5ac2004-07-18 06:16:08 +000070
Jack Jansen4b76ba31997-01-09 16:26:23 +000071def _decode_boolean(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000072 return ord(data[0])
Tim Peters182b5ac2004-07-18 06:16:08 +000073
Jack Jansen4b76ba31997-01-09 16:26:23 +000074def _decode_text(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000075 return data
Tim Peters182b5ac2004-07-18 06:16:08 +000076
Jack Jansen4b76ba31997-01-09 16:26:23 +000077def _decode_charset(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000078 return data[:256], data[256:]
Tim Peters182b5ac2004-07-18 06:16:08 +000079
Jack Jansen4b76ba31997-01-09 16:26:23 +000080def _decode_appspec(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000081 namelen = ord(data[4])
82 return data[0:4], data[5:5+namelen]
Jack Jansen4b76ba31997-01-09 16:26:23 +000083
84def _code_default(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000085 return chr(len(data)) + data
Tim Peters182b5ac2004-07-18 06:16:08 +000086
Jack Jansen4b76ba31997-01-09 16:26:23 +000087def _code_multistr(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000088 numstr = len(data)
89 rv = chr((numstr>>8) & 0xff) + chr(numstr & 0xff)
90 for i in data:
91 rv = rv + _code_default(i)
92 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +000093
Jack Jansen4b76ba31997-01-09 16:26:23 +000094def _code_fontrecord(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000095 size, face, name = data
96 return chr((size>>8) & 0xff) + chr(size & 0xff) + chr(face & 0xff) + \
97 chr(0) + _code_default(name)
Tim Peters182b5ac2004-07-18 06:16:08 +000098
Jack Jansen4b76ba31997-01-09 16:26:23 +000099def _code_boolean(data, key):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000100 print 'XXXX boolean:', repr(data)
Jack Jansen0ae32202003-04-09 13:25:43 +0000101 return chr(data)
Tim Peters182b5ac2004-07-18 06:16:08 +0000102
Jack Jansen4b76ba31997-01-09 16:26:23 +0000103def _code_text(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000104 return data
Tim Peters182b5ac2004-07-18 06:16:08 +0000105
Jack Jansen4b76ba31997-01-09 16:26:23 +0000106def _code_charset(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000107 return data[0] + data[1]
Tim Peters182b5ac2004-07-18 06:16:08 +0000108
Jack Jansen4b76ba31997-01-09 16:26:23 +0000109def _code_appspec(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000110 return data[0] + _code_default(data[1])
Tim Peters182b5ac2004-07-18 06:16:08 +0000111
Jack Jansen4b76ba31997-01-09 16:26:23 +0000112_decoder_table = {
Jack Jansen0ae32202003-04-09 13:25:43 +0000113 "ArchieAll" : (_decode_multistr , _code_multistr),
114 "UMichAll" : (_decode_multistr , _code_multistr),
115 "InfoMacAll" : (_decode_multistr , _code_multistr),
116 "ListFont" : (_decode_fontrecord , _code_fontrecord),
117 "ScreenFont" : (_decode_fontrecord , _code_fontrecord),
118 "PrinterFont" : (_decode_fontrecord , _code_fontrecord),
119# "DownloadFolder" : (_decode_filespec , _code_filespec),
120 "Signature": (_decode_text , _code_text),
121 "Plan" : (_decode_text , _code_text),
122 "MailHeaders" : (_decode_text , _code_text),
123 "NewsHeaders" : (_decode_text , _code_text),
Tim Peters182b5ac2004-07-18 06:16:08 +0000124# "Mapping"
Jack Jansen0ae32202003-04-09 13:25:43 +0000125 "CharacterSet" : (_decode_charset , _code_charset),
126 "Helper\245" : (_decode_appspec , _code_appspec),
127# "Services" : (_decode_services, ????),
128 "NewMailFlashIcon" : (_decode_boolean , _code_boolean),
129 "NewMailDialog" : (_decode_boolean , _code_boolean),
130 "NewMailPlaySound" : (_decode_boolean , _code_boolean),
131# "WebBackgroundColor" : _decode_color,
132 "NoProxyDomains" : (_decode_multistr , _code_multistr),
133 "UseHTTPProxy" : (_decode_boolean , _code_boolean),
134 "UseGopherProxy": (_decode_boolean , _code_boolean),
135 "UseFTPProxy" : (_decode_boolean , _code_boolean),
136 "UsePassiveFTP" : (_decode_boolean , _code_boolean),
Jack Jansen4b76ba31997-01-09 16:26:23 +0000137}
138
139def _decode(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000140 if '\245' in key:
141 key2 = key[:string.index(key, '\245')+1]
142 else:
143 key2 = key
144 if _decoder_table.has_key(key2):
145 decoder = _decoder_table[key2][0]
146 else:
147 decoder = _decode_default
148 return decoder(data, key)
Jack Jansen4b76ba31997-01-09 16:26:23 +0000149
150def _code(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000151 if type(data) == _ICOpaqueDataType:
152 return data.data
153 if '\245' in key:
154 key2 = key[:string.index(key, '\245')+1]
155 else:
156 key2 = key
157 if _decoder_table.has_key(key2):
158 coder = _decoder_table[key2][1]
159 else:
160 coder = _code_default
161 return coder(data, key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000162
Jack Jansen4b76ba31997-01-09 16:26:23 +0000163class IC:
Jack Jansen0ae32202003-04-09 13:25:43 +0000164 def __init__(self, signature='Pyth', ic=None):
165 if ic:
166 self.ic = ic
167 else:
168 self.ic = icglue.ICStart(signature)
169 if hasattr(self.ic, 'ICFindConfigFile'):
170 self.ic.ICFindConfigFile()
171 self.h = Res.Resource('')
Tim Peters182b5ac2004-07-18 06:16:08 +0000172
Jack Jansen0ae32202003-04-09 13:25:43 +0000173 def keys(self):
174 rv = []
175 self.ic.ICBegin(icReadOnlyPerm)
176 num = self.ic.ICCountPref()
177 for i in range(num):
178 rv.append(self.ic.ICGetIndPref(i+1))
179 self.ic.ICEnd()
180 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +0000181
Jack Jansen0ae32202003-04-09 13:25:43 +0000182 def has_key(self, key):
183 return self.__contains__(key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000184
Jack Jansen0ae32202003-04-09 13:25:43 +0000185 def __contains__(self, key):
186 try:
187 dummy = self.ic.ICFindPrefHandle(key, self.h)
188 except icglue.error:
189 return 0
190 return 1
Tim Peters182b5ac2004-07-18 06:16:08 +0000191
Jack Jansen0ae32202003-04-09 13:25:43 +0000192 def __getitem__(self, key):
193 attr = self.ic.ICFindPrefHandle(key, self.h)
194 return _decode(self.h.data, key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000195
Jack Jansen0ae32202003-04-09 13:25:43 +0000196 def __setitem__(self, key, value):
197 value = _code(value, key)
198 self.ic.ICSetPref(key, ICattr_no_change, value)
Tim Peters182b5ac2004-07-18 06:16:08 +0000199
Jack Jansen0ae32202003-04-09 13:25:43 +0000200 def launchurl(self, url, hint=""):
201 # Work around a bug in ICLaunchURL: file:/foo does
202 # not work but file:///foo does.
203 if url[:6] == 'file:/' and url[6] != '/':
204 url = 'file:///' + url[6:]
205 self.ic.ICLaunchURL(hint, url, 0, len(url))
Tim Peters182b5ac2004-07-18 06:16:08 +0000206
Jack Jansen0ae32202003-04-09 13:25:43 +0000207 def parseurl(self, data, start=None, end=None, hint=""):
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000208 if start is None:
Jack Jansen0ae32202003-04-09 13:25:43 +0000209 selStart = 0
210 selEnd = len(data)
211 else:
212 selStart = selEnd = start
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000213 if end is not None:
Jack Jansen0ae32202003-04-09 13:25:43 +0000214 selEnd = end
215 selStart, selEnd = self.ic.ICParseURL(hint, data, selStart, selEnd, self.h)
216 return self.h.data, selStart, selEnd
Tim Peters182b5ac2004-07-18 06:16:08 +0000217
Jack Jansen0ae32202003-04-09 13:25:43 +0000218 def mapfile(self, file):
219 if type(file) != type(''):
220 file = file.as_tuple()[2]
221 return self.ic.ICMapFilename(file)
Tim Peters182b5ac2004-07-18 06:16:08 +0000222
Jack Jansen0ae32202003-04-09 13:25:43 +0000223 def maptypecreator(self, type, creator, filename=""):
224 return self.ic.ICMapTypeCreator(type, creator, filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000225
Jack Jansen0ae32202003-04-09 13:25:43 +0000226 def settypecreator(self, file):
227 file = Carbon.File.pathname(file)
228 record = self.mapfile(os.path.split(file)[1])
229 MacOS.SetCreatorAndType(file, record[2], record[1])
230 macostools.touched(fss)
Tim Peters182b5ac2004-07-18 06:16:08 +0000231
Jack Jansen4b76ba31997-01-09 16:26:23 +0000232# Convenience routines
233_dft_ic = None
234
235def launchurl(url, hint=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000236 global _dft_ic
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000237 if _dft_ic is None: _dft_ic = IC()
Jack Jansen0ae32202003-04-09 13:25:43 +0000238 return _dft_ic.launchurl(url, hint)
Tim Peters182b5ac2004-07-18 06:16:08 +0000239
Jack Jansen4b76ba31997-01-09 16:26:23 +0000240def parseurl(data, start=None, end=None, hint=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000241 global _dft_ic
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000242 if _dft_ic is None: _dft_ic = IC()
Jack Jansen0ae32202003-04-09 13:25:43 +0000243 return _dft_ic.parseurl(data, start, end, hint)
Tim Peters182b5ac2004-07-18 06:16:08 +0000244
Jack Jansen4b76ba31997-01-09 16:26:23 +0000245def mapfile(filename):
Jack Jansen0ae32202003-04-09 13:25:43 +0000246 global _dft_ic
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000247 if _dft_ic is None: _dft_ic = IC()
Jack Jansen0ae32202003-04-09 13:25:43 +0000248 return _dft_ic.mapfile(filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000249
Jack Jansen4b76ba31997-01-09 16:26:23 +0000250def maptypecreator(type, creator, filename=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000251 global _dft_ic
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000252 if _dft_ic is None: _dft_ic = IC()
Jack Jansen0ae32202003-04-09 13:25:43 +0000253 return _dft_ic.maptypecreator(type, creator, filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000254
Jack Jansen4b76ba31997-01-09 16:26:23 +0000255def settypecreator(file):
Jack Jansen0ae32202003-04-09 13:25:43 +0000256 global _dft_ic
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000257 if _dft_ic is None: _dft_ic = IC()
Jack Jansen0ae32202003-04-09 13:25:43 +0000258 return _dft_ic.settypecreator(file)
Tim Peters182b5ac2004-07-18 06:16:08 +0000259
Jack Jansen4b76ba31997-01-09 16:26:23 +0000260def _test():
Jack Jansen0ae32202003-04-09 13:25:43 +0000261 ic = IC()
262 for k in ic.keys():
263 try:
264 v = ic[k]
265 except error:
266 v = '????'
267 print k, '\t', v
268 sys.exit(1)
Tim Peters182b5ac2004-07-18 06:16:08 +0000269
Jack Jansen4b76ba31997-01-09 16:26:23 +0000270if __name__ == '__main__':
Jack Jansen0ae32202003-04-09 13:25:43 +0000271 _test()