blob: 6575336af1a8094a9fcc4515ebde1c9ed956f233 [file] [log] [blame]
Jack Jansen4b76ba31997-01-09 16:26:23 +00001"""IC wrapper module, based on Internet Config 1.3"""
2
3import icglue
4import string
5import sys
Jack Jansencf0b2e82003-02-05 15:49:19 +00006import os
Jack Jansen5a6fdcd2001-08-25 12:15:04 +00007from Carbon import Res
Jack Jansencf0b2e82003-02-05 15:49:19 +00008import Carbon.File
Jack Jansen4b76ba31997-01-09 16:26:23 +00009import macostools
10
11error=icglue.error
12
13# From ictypes.h:
Jack Jansen0ae32202003-04-09 13:25:43 +000014icPrefNotFoundErr = -666 # preference not found (duh!)
15icPermErr = -667 # cannot set preference
16icPrefDataErr = -668 # problem with preference data
17icInternalErr = -669 # hmm, this is not good
18icTruncatedErr = -670 # more data was present than was returned
19icNoMoreWritersErr = -671 # you cannot begin a write session because someone else is already doing it */
20icNothingToOverrideErr = -672 # no component for the override component to capture
21icNoURLErr = -673 # no URL found
22icConfigNotFoundErr = -674 # no configuration was found
23icConfigInappropriateErr = -675 # incorrect manufacturer code
Jack Jansen4b76ba31997-01-09 16:26:23 +000024
25ICattr_no_change = -1
26
27icNoPerm = 0
28icReadOnlyPerm = 1
29icReadWritePerm = 2
30# End of ictypes.h
31
Jack Jansen8dc797d1997-01-10 15:25:47 +000032class ICOpaqueData:
Jack Jansen0ae32202003-04-09 13:25:43 +000033 """An unparseable IC entry"""
34 def __init__(self, data):
35 self.data = data
Jack Jansen8dc797d1997-01-10 15:25:47 +000036
Jack Jansen0ae32202003-04-09 13:25:43 +000037 def __repr__(self):
Walter Dörwald70a6b492004-02-12 17:35:32 +000038 return "ICOpaqueData(%r)"%(self.data,)
Jack Jansen8dc797d1997-01-10 15:25:47 +000039
40_ICOpaqueDataType=type(ICOpaqueData(''))
Tim Peters182b5ac2004-07-18 06:16:08 +000041
Jack Jansen4b76ba31997-01-09 16:26:23 +000042def _decode_default(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000043 if len(data) == 0:
44 return data
45 if ord(data[0]) == len(data)-1:
46 # Assume Pstring
47 return data[1:]
48 return ICOpaqueData(data)
Tim Peters182b5ac2004-07-18 06:16:08 +000049
50
Jack Jansen4b76ba31997-01-09 16:26:23 +000051def _decode_multistr(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000052 numstr = ord(data[0]) << 8 | ord(data[1])
53 rv = []
54 ptr = 2
55 for i in range(numstr):
56 strlen = ord(data[ptr])
57 str = data[ptr+1:ptr+strlen+1]
58 rv.append(str)
59 ptr = ptr + strlen + 1
60 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +000061
Jack Jansen4b76ba31997-01-09 16:26:23 +000062def _decode_fontrecord(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000063 size = ord(data[0]) << 8 | ord(data[1])
64 face = ord(data[2])
65 namelen = ord(data[4])
66 return size, face, data[5:5+namelen]
Tim Peters182b5ac2004-07-18 06:16:08 +000067
Jack Jansen4b76ba31997-01-09 16:26:23 +000068def _decode_boolean(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000069 return ord(data[0])
Tim Peters182b5ac2004-07-18 06:16:08 +000070
Jack Jansen4b76ba31997-01-09 16:26:23 +000071def _decode_text(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000072 return data
Tim Peters182b5ac2004-07-18 06:16:08 +000073
Jack Jansen4b76ba31997-01-09 16:26:23 +000074def _decode_charset(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000075 return data[:256], data[256:]
Tim Peters182b5ac2004-07-18 06:16:08 +000076
Jack Jansen4b76ba31997-01-09 16:26:23 +000077def _decode_appspec(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000078 namelen = ord(data[4])
79 return data[0:4], data[5:5+namelen]
Jack Jansen4b76ba31997-01-09 16:26:23 +000080
81def _code_default(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000082 return chr(len(data)) + data
Tim Peters182b5ac2004-07-18 06:16:08 +000083
Jack Jansen4b76ba31997-01-09 16:26:23 +000084def _code_multistr(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000085 numstr = len(data)
86 rv = chr((numstr>>8) & 0xff) + chr(numstr & 0xff)
87 for i in data:
88 rv = rv + _code_default(i)
89 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +000090
Jack Jansen4b76ba31997-01-09 16:26:23 +000091def _code_fontrecord(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000092 size, face, name = data
93 return chr((size>>8) & 0xff) + chr(size & 0xff) + chr(face & 0xff) + \
94 chr(0) + _code_default(name)
Tim Peters182b5ac2004-07-18 06:16:08 +000095
Jack Jansen4b76ba31997-01-09 16:26:23 +000096def _code_boolean(data, key):
Walter Dörwald70a6b492004-02-12 17:35:32 +000097 print 'XXXX boolean:', repr(data)
Jack Jansen0ae32202003-04-09 13:25:43 +000098 return chr(data)
Tim Peters182b5ac2004-07-18 06:16:08 +000099
Jack Jansen4b76ba31997-01-09 16:26:23 +0000100def _code_text(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000101 return data
Tim Peters182b5ac2004-07-18 06:16:08 +0000102
Jack Jansen4b76ba31997-01-09 16:26:23 +0000103def _code_charset(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000104 return data[0] + data[1]
Tim Peters182b5ac2004-07-18 06:16:08 +0000105
Jack Jansen4b76ba31997-01-09 16:26:23 +0000106def _code_appspec(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000107 return data[0] + _code_default(data[1])
Tim Peters182b5ac2004-07-18 06:16:08 +0000108
Jack Jansen4b76ba31997-01-09 16:26:23 +0000109_decoder_table = {
Jack Jansen0ae32202003-04-09 13:25:43 +0000110 "ArchieAll" : (_decode_multistr , _code_multistr),
111 "UMichAll" : (_decode_multistr , _code_multistr),
112 "InfoMacAll" : (_decode_multistr , _code_multistr),
113 "ListFont" : (_decode_fontrecord , _code_fontrecord),
114 "ScreenFont" : (_decode_fontrecord , _code_fontrecord),
115 "PrinterFont" : (_decode_fontrecord , _code_fontrecord),
116# "DownloadFolder" : (_decode_filespec , _code_filespec),
117 "Signature": (_decode_text , _code_text),
118 "Plan" : (_decode_text , _code_text),
119 "MailHeaders" : (_decode_text , _code_text),
120 "NewsHeaders" : (_decode_text , _code_text),
Tim Peters182b5ac2004-07-18 06:16:08 +0000121# "Mapping"
Jack Jansen0ae32202003-04-09 13:25:43 +0000122 "CharacterSet" : (_decode_charset , _code_charset),
123 "Helper\245" : (_decode_appspec , _code_appspec),
124# "Services" : (_decode_services, ????),
125 "NewMailFlashIcon" : (_decode_boolean , _code_boolean),
126 "NewMailDialog" : (_decode_boolean , _code_boolean),
127 "NewMailPlaySound" : (_decode_boolean , _code_boolean),
128# "WebBackgroundColor" : _decode_color,
129 "NoProxyDomains" : (_decode_multistr , _code_multistr),
130 "UseHTTPProxy" : (_decode_boolean , _code_boolean),
131 "UseGopherProxy": (_decode_boolean , _code_boolean),
132 "UseFTPProxy" : (_decode_boolean , _code_boolean),
133 "UsePassiveFTP" : (_decode_boolean , _code_boolean),
Jack Jansen4b76ba31997-01-09 16:26:23 +0000134}
135
136def _decode(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000137 if '\245' in key:
138 key2 = key[:string.index(key, '\245')+1]
139 else:
140 key2 = key
141 if _decoder_table.has_key(key2):
142 decoder = _decoder_table[key2][0]
143 else:
144 decoder = _decode_default
145 return decoder(data, key)
Jack Jansen4b76ba31997-01-09 16:26:23 +0000146
147def _code(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000148 if type(data) == _ICOpaqueDataType:
149 return data.data
150 if '\245' in key:
151 key2 = key[:string.index(key, '\245')+1]
152 else:
153 key2 = key
154 if _decoder_table.has_key(key2):
155 coder = _decoder_table[key2][1]
156 else:
157 coder = _code_default
158 return coder(data, key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000159
Jack Jansen4b76ba31997-01-09 16:26:23 +0000160class IC:
Jack Jansen0ae32202003-04-09 13:25:43 +0000161 def __init__(self, signature='Pyth', ic=None):
162 if ic:
163 self.ic = ic
164 else:
165 self.ic = icglue.ICStart(signature)
166 if hasattr(self.ic, 'ICFindConfigFile'):
167 self.ic.ICFindConfigFile()
168 self.h = Res.Resource('')
Tim Peters182b5ac2004-07-18 06:16:08 +0000169
Jack Jansen0ae32202003-04-09 13:25:43 +0000170 def keys(self):
171 rv = []
172 self.ic.ICBegin(icReadOnlyPerm)
173 num = self.ic.ICCountPref()
174 for i in range(num):
175 rv.append(self.ic.ICGetIndPref(i+1))
176 self.ic.ICEnd()
177 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +0000178
Jack Jansen0ae32202003-04-09 13:25:43 +0000179 def has_key(self, key):
180 return self.__contains__(key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000181
Jack Jansen0ae32202003-04-09 13:25:43 +0000182 def __contains__(self, key):
183 try:
184 dummy = self.ic.ICFindPrefHandle(key, self.h)
185 except icglue.error:
186 return 0
187 return 1
Tim Peters182b5ac2004-07-18 06:16:08 +0000188
Jack Jansen0ae32202003-04-09 13:25:43 +0000189 def __getitem__(self, key):
190 attr = self.ic.ICFindPrefHandle(key, self.h)
191 return _decode(self.h.data, key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000192
Jack Jansen0ae32202003-04-09 13:25:43 +0000193 def __setitem__(self, key, value):
194 value = _code(value, key)
195 self.ic.ICSetPref(key, ICattr_no_change, value)
Tim Peters182b5ac2004-07-18 06:16:08 +0000196
Jack Jansen0ae32202003-04-09 13:25:43 +0000197 def launchurl(self, url, hint=""):
198 # Work around a bug in ICLaunchURL: file:/foo does
199 # not work but file:///foo does.
200 if url[:6] == 'file:/' and url[6] != '/':
201 url = 'file:///' + url[6:]
202 self.ic.ICLaunchURL(hint, url, 0, len(url))
Tim Peters182b5ac2004-07-18 06:16:08 +0000203
Jack Jansen0ae32202003-04-09 13:25:43 +0000204 def parseurl(self, data, start=None, end=None, hint=""):
205 if start == None:
206 selStart = 0
207 selEnd = len(data)
208 else:
209 selStart = selEnd = start
210 if end != None:
211 selEnd = end
212 selStart, selEnd = self.ic.ICParseURL(hint, data, selStart, selEnd, self.h)
213 return self.h.data, selStart, selEnd
Tim Peters182b5ac2004-07-18 06:16:08 +0000214
Jack Jansen0ae32202003-04-09 13:25:43 +0000215 def mapfile(self, file):
216 if type(file) != type(''):
217 file = file.as_tuple()[2]
218 return self.ic.ICMapFilename(file)
Tim Peters182b5ac2004-07-18 06:16:08 +0000219
Jack Jansen0ae32202003-04-09 13:25:43 +0000220 def maptypecreator(self, type, creator, filename=""):
221 return self.ic.ICMapTypeCreator(type, creator, filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000222
Jack Jansen0ae32202003-04-09 13:25:43 +0000223 def settypecreator(self, file):
224 file = Carbon.File.pathname(file)
225 record = self.mapfile(os.path.split(file)[1])
226 MacOS.SetCreatorAndType(file, record[2], record[1])
227 macostools.touched(fss)
Tim Peters182b5ac2004-07-18 06:16:08 +0000228
Jack Jansen4b76ba31997-01-09 16:26:23 +0000229# Convenience routines
230_dft_ic = None
231
232def launchurl(url, hint=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000233 global _dft_ic
234 if _dft_ic == None: _dft_ic = IC()
235 return _dft_ic.launchurl(url, hint)
Tim Peters182b5ac2004-07-18 06:16:08 +0000236
Jack Jansen4b76ba31997-01-09 16:26:23 +0000237def parseurl(data, start=None, end=None, hint=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000238 global _dft_ic
239 if _dft_ic == None: _dft_ic = IC()
240 return _dft_ic.parseurl(data, start, end, hint)
Tim Peters182b5ac2004-07-18 06:16:08 +0000241
Jack Jansen4b76ba31997-01-09 16:26:23 +0000242def mapfile(filename):
Jack Jansen0ae32202003-04-09 13:25:43 +0000243 global _dft_ic
244 if _dft_ic == None: _dft_ic = IC()
245 return _dft_ic.mapfile(filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000246
Jack Jansen4b76ba31997-01-09 16:26:23 +0000247def maptypecreator(type, creator, filename=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000248 global _dft_ic
249 if _dft_ic == None: _dft_ic = IC()
250 return _dft_ic.maptypecreator(type, creator, filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000251
Jack Jansen4b76ba31997-01-09 16:26:23 +0000252def settypecreator(file):
Jack Jansen0ae32202003-04-09 13:25:43 +0000253 global _dft_ic
254 if _dft_ic == None: _dft_ic = IC()
255 return _dft_ic.settypecreator(file)
Tim Peters182b5ac2004-07-18 06:16:08 +0000256
Jack Jansen4b76ba31997-01-09 16:26:23 +0000257def _test():
Jack Jansen0ae32202003-04-09 13:25:43 +0000258 ic = IC()
259 for k in ic.keys():
260 try:
261 v = ic[k]
262 except error:
263 v = '????'
264 print k, '\t', v
265 sys.exit(1)
Tim Peters182b5ac2004-07-18 06:16:08 +0000266
Jack Jansen4b76ba31997-01-09 16:26:23 +0000267if __name__ == '__main__':
Jack Jansen0ae32202003-04-09 13:25:43 +0000268 _test()