blob: 769400ae8eac59869bfca547543f5d432b0a2953 [file] [log] [blame]
Jack Jansen4b76ba31997-01-09 16:26:23 +00001"""IC wrapper module, based on Internet Config 1.3"""
2
3import icglue
Jack Jansen4b76ba31997-01-09 16:26:23 +00004import sys
Jack Jansencf0b2e82003-02-05 15:49:19 +00005import os
Jack Jansen5a6fdcd2001-08-25 12:15:04 +00006from Carbon import Res
Jack Jansencf0b2e82003-02-05 15:49:19 +00007import Carbon.File
Jack Jansen4b76ba31997-01-09 16:26:23 +00008import macostools
9
10error=icglue.error
11
12# From ictypes.h:
Jack Jansen0ae32202003-04-09 13:25:43 +000013icPrefNotFoundErr = -666 # preference not found (duh!)
14icPermErr = -667 # cannot set preference
15icPrefDataErr = -668 # problem with preference data
16icInternalErr = -669 # hmm, this is not good
17icTruncatedErr = -670 # more data was present than was returned
18icNoMoreWritersErr = -671 # you cannot begin a write session because someone else is already doing it */
19icNothingToOverrideErr = -672 # no component for the override component to capture
20icNoURLErr = -673 # no URL found
21icConfigNotFoundErr = -674 # no configuration was found
22icConfigInappropriateErr = -675 # incorrect manufacturer code
Jack Jansen4b76ba31997-01-09 16:26:23 +000023
24ICattr_no_change = -1
25
26icNoPerm = 0
27icReadOnlyPerm = 1
28icReadWritePerm = 2
29# End of ictypes.h
30
Jack Jansen8dc797d1997-01-10 15:25:47 +000031class ICOpaqueData:
Jack Jansen0ae32202003-04-09 13:25:43 +000032 """An unparseable IC entry"""
33 def __init__(self, data):
34 self.data = data
Jack Jansen8dc797d1997-01-10 15:25:47 +000035
Jack Jansen0ae32202003-04-09 13:25:43 +000036 def __repr__(self):
Walter Dörwald70a6b492004-02-12 17:35:32 +000037 return "ICOpaqueData(%r)"%(self.data,)
Jack Jansen8dc797d1997-01-10 15:25:47 +000038
39_ICOpaqueDataType=type(ICOpaqueData(''))
Tim Peters182b5ac2004-07-18 06:16:08 +000040
Jack Jansen4b76ba31997-01-09 16:26:23 +000041def _decode_default(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000042 if len(data) == 0:
43 return data
44 if ord(data[0]) == len(data)-1:
45 # Assume Pstring
46 return data[1:]
47 return ICOpaqueData(data)
Tim Peters182b5ac2004-07-18 06:16:08 +000048
49
Jack Jansen4b76ba31997-01-09 16:26:23 +000050def _decode_multistr(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000051 numstr = ord(data[0]) << 8 | ord(data[1])
52 rv = []
53 ptr = 2
54 for i in range(numstr):
55 strlen = ord(data[ptr])
56 str = data[ptr+1:ptr+strlen+1]
57 rv.append(str)
58 ptr = ptr + strlen + 1
59 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +000060
Jack Jansen4b76ba31997-01-09 16:26:23 +000061def _decode_fontrecord(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000062 size = ord(data[0]) << 8 | ord(data[1])
63 face = ord(data[2])
64 namelen = ord(data[4])
65 return size, face, data[5:5+namelen]
Tim Peters182b5ac2004-07-18 06:16:08 +000066
Jack Jansen4b76ba31997-01-09 16:26:23 +000067def _decode_boolean(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000068 return ord(data[0])
Tim Peters182b5ac2004-07-18 06:16:08 +000069
Jack Jansen4b76ba31997-01-09 16:26:23 +000070def _decode_text(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000071 return data
Tim Peters182b5ac2004-07-18 06:16:08 +000072
Jack Jansen4b76ba31997-01-09 16:26:23 +000073def _decode_charset(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000074 return data[:256], data[256:]
Tim Peters182b5ac2004-07-18 06:16:08 +000075
Jack Jansen4b76ba31997-01-09 16:26:23 +000076def _decode_appspec(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000077 namelen = ord(data[4])
78 return data[0:4], data[5:5+namelen]
Jack Jansen4b76ba31997-01-09 16:26:23 +000079
80def _code_default(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000081 return chr(len(data)) + data
Tim Peters182b5ac2004-07-18 06:16:08 +000082
Jack Jansen4b76ba31997-01-09 16:26:23 +000083def _code_multistr(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000084 numstr = len(data)
85 rv = chr((numstr>>8) & 0xff) + chr(numstr & 0xff)
86 for i in data:
87 rv = rv + _code_default(i)
88 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +000089
Jack Jansen4b76ba31997-01-09 16:26:23 +000090def _code_fontrecord(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +000091 size, face, name = data
92 return chr((size>>8) & 0xff) + chr(size & 0xff) + chr(face & 0xff) + \
93 chr(0) + _code_default(name)
Tim Peters182b5ac2004-07-18 06:16:08 +000094
Jack Jansen4b76ba31997-01-09 16:26:23 +000095def _code_boolean(data, key):
Guido van Rossumbe19ed72007-02-09 05:37:30 +000096 print('XXXX boolean:', repr(data))
Jack Jansen0ae32202003-04-09 13:25:43 +000097 return chr(data)
Tim Peters182b5ac2004-07-18 06:16:08 +000098
Jack Jansen4b76ba31997-01-09 16:26:23 +000099def _code_text(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000100 return data
Tim Peters182b5ac2004-07-18 06:16:08 +0000101
Jack Jansen4b76ba31997-01-09 16:26:23 +0000102def _code_charset(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000103 return data[0] + data[1]
Tim Peters182b5ac2004-07-18 06:16:08 +0000104
Jack Jansen4b76ba31997-01-09 16:26:23 +0000105def _code_appspec(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000106 return data[0] + _code_default(data[1])
Tim Peters182b5ac2004-07-18 06:16:08 +0000107
Jack Jansen4b76ba31997-01-09 16:26:23 +0000108_decoder_table = {
Jack Jansen0ae32202003-04-09 13:25:43 +0000109 "ArchieAll" : (_decode_multistr , _code_multistr),
110 "UMichAll" : (_decode_multistr , _code_multistr),
111 "InfoMacAll" : (_decode_multistr , _code_multistr),
112 "ListFont" : (_decode_fontrecord , _code_fontrecord),
113 "ScreenFont" : (_decode_fontrecord , _code_fontrecord),
114 "PrinterFont" : (_decode_fontrecord , _code_fontrecord),
115# "DownloadFolder" : (_decode_filespec , _code_filespec),
116 "Signature": (_decode_text , _code_text),
117 "Plan" : (_decode_text , _code_text),
118 "MailHeaders" : (_decode_text , _code_text),
119 "NewsHeaders" : (_decode_text , _code_text),
Tim Peters182b5ac2004-07-18 06:16:08 +0000120# "Mapping"
Jack Jansen0ae32202003-04-09 13:25:43 +0000121 "CharacterSet" : (_decode_charset , _code_charset),
122 "Helper\245" : (_decode_appspec , _code_appspec),
123# "Services" : (_decode_services, ????),
124 "NewMailFlashIcon" : (_decode_boolean , _code_boolean),
125 "NewMailDialog" : (_decode_boolean , _code_boolean),
126 "NewMailPlaySound" : (_decode_boolean , _code_boolean),
127# "WebBackgroundColor" : _decode_color,
128 "NoProxyDomains" : (_decode_multistr , _code_multistr),
129 "UseHTTPProxy" : (_decode_boolean , _code_boolean),
130 "UseGopherProxy": (_decode_boolean , _code_boolean),
131 "UseFTPProxy" : (_decode_boolean , _code_boolean),
132 "UsePassiveFTP" : (_decode_boolean , _code_boolean),
Jack Jansen4b76ba31997-01-09 16:26:23 +0000133}
134
135def _decode(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000136 if '\245' in key:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000137 key2 = key[:key.index('\245')+1]
Jack Jansen0ae32202003-04-09 13:25:43 +0000138 else:
139 key2 = key
Neal Norwitzf1a69c12006-08-20 16:25:10 +0000140 if key2 in _decoder_table:
Jack Jansen0ae32202003-04-09 13:25:43 +0000141 decoder = _decoder_table[key2][0]
142 else:
143 decoder = _decode_default
144 return decoder(data, key)
Jack Jansen4b76ba31997-01-09 16:26:23 +0000145
146def _code(data, key):
Jack Jansen0ae32202003-04-09 13:25:43 +0000147 if type(data) == _ICOpaqueDataType:
148 return data.data
149 if '\245' in key:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000150 key2 = key[:key.index('\245')+1]
Jack Jansen0ae32202003-04-09 13:25:43 +0000151 else:
152 key2 = key
Neal Norwitzf1a69c12006-08-20 16:25:10 +0000153 if key2 in _decoder_table:
Jack Jansen0ae32202003-04-09 13:25:43 +0000154 coder = _decoder_table[key2][1]
155 else:
156 coder = _code_default
157 return coder(data, key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000158
Jack Jansen4b76ba31997-01-09 16:26:23 +0000159class IC:
Jack Jansen0ae32202003-04-09 13:25:43 +0000160 def __init__(self, signature='Pyth', ic=None):
161 if ic:
162 self.ic = ic
163 else:
164 self.ic = icglue.ICStart(signature)
165 if hasattr(self.ic, 'ICFindConfigFile'):
166 self.ic.ICFindConfigFile()
167 self.h = Res.Resource('')
Tim Peters182b5ac2004-07-18 06:16:08 +0000168
Jack Jansen0ae32202003-04-09 13:25:43 +0000169 def keys(self):
170 rv = []
171 self.ic.ICBegin(icReadOnlyPerm)
172 num = self.ic.ICCountPref()
173 for i in range(num):
174 rv.append(self.ic.ICGetIndPref(i+1))
175 self.ic.ICEnd()
176 return rv
Tim Peters182b5ac2004-07-18 06:16:08 +0000177
Jack Jansen0ae32202003-04-09 13:25:43 +0000178 def __contains__(self, key):
179 try:
180 dummy = self.ic.ICFindPrefHandle(key, self.h)
181 except icglue.error:
182 return 0
183 return 1
Tim Peters182b5ac2004-07-18 06:16:08 +0000184
Jack Jansen0ae32202003-04-09 13:25:43 +0000185 def __getitem__(self, key):
186 attr = self.ic.ICFindPrefHandle(key, self.h)
187 return _decode(self.h.data, key)
Tim Peters182b5ac2004-07-18 06:16:08 +0000188
Jack Jansen0ae32202003-04-09 13:25:43 +0000189 def __setitem__(self, key, value):
190 value = _code(value, key)
191 self.ic.ICSetPref(key, ICattr_no_change, value)
Tim Peters182b5ac2004-07-18 06:16:08 +0000192
Jack Jansen0ae32202003-04-09 13:25:43 +0000193 def launchurl(self, url, hint=""):
194 # Work around a bug in ICLaunchURL: file:/foo does
195 # not work but file:///foo does.
196 if url[:6] == 'file:/' and url[6] != '/':
197 url = 'file:///' + url[6:]
198 self.ic.ICLaunchURL(hint, url, 0, len(url))
Tim Peters182b5ac2004-07-18 06:16:08 +0000199
Jack Jansen0ae32202003-04-09 13:25:43 +0000200 def parseurl(self, data, start=None, end=None, hint=""):
201 if start == None:
202 selStart = 0
203 selEnd = len(data)
204 else:
205 selStart = selEnd = start
206 if end != None:
207 selEnd = end
208 selStart, selEnd = self.ic.ICParseURL(hint, data, selStart, selEnd, self.h)
209 return self.h.data, selStart, selEnd
Tim Peters182b5ac2004-07-18 06:16:08 +0000210
Jack Jansen0ae32202003-04-09 13:25:43 +0000211 def mapfile(self, file):
212 if type(file) != type(''):
213 file = file.as_tuple()[2]
214 return self.ic.ICMapFilename(file)
Tim Peters182b5ac2004-07-18 06:16:08 +0000215
Jack Jansen0ae32202003-04-09 13:25:43 +0000216 def maptypecreator(self, type, creator, filename=""):
217 return self.ic.ICMapTypeCreator(type, creator, filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000218
Jack Jansen0ae32202003-04-09 13:25:43 +0000219 def settypecreator(self, file):
220 file = Carbon.File.pathname(file)
221 record = self.mapfile(os.path.split(file)[1])
222 MacOS.SetCreatorAndType(file, record[2], record[1])
223 macostools.touched(fss)
Tim Peters182b5ac2004-07-18 06:16:08 +0000224
Jack Jansen4b76ba31997-01-09 16:26:23 +0000225# Convenience routines
226_dft_ic = None
227
228def launchurl(url, hint=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000229 global _dft_ic
230 if _dft_ic == None: _dft_ic = IC()
231 return _dft_ic.launchurl(url, hint)
Tim Peters182b5ac2004-07-18 06:16:08 +0000232
Jack Jansen4b76ba31997-01-09 16:26:23 +0000233def parseurl(data, start=None, end=None, hint=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000234 global _dft_ic
235 if _dft_ic == None: _dft_ic = IC()
236 return _dft_ic.parseurl(data, start, end, hint)
Tim Peters182b5ac2004-07-18 06:16:08 +0000237
Jack Jansen4b76ba31997-01-09 16:26:23 +0000238def mapfile(filename):
Jack Jansen0ae32202003-04-09 13:25:43 +0000239 global _dft_ic
240 if _dft_ic == None: _dft_ic = IC()
241 return _dft_ic.mapfile(filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000242
Jack Jansen4b76ba31997-01-09 16:26:23 +0000243def maptypecreator(type, creator, filename=""):
Jack Jansen0ae32202003-04-09 13:25:43 +0000244 global _dft_ic
245 if _dft_ic == None: _dft_ic = IC()
246 return _dft_ic.maptypecreator(type, creator, filename)
Tim Peters182b5ac2004-07-18 06:16:08 +0000247
Jack Jansen4b76ba31997-01-09 16:26:23 +0000248def settypecreator(file):
Jack Jansen0ae32202003-04-09 13:25:43 +0000249 global _dft_ic
250 if _dft_ic == None: _dft_ic = IC()
251 return _dft_ic.settypecreator(file)
Tim Peters182b5ac2004-07-18 06:16:08 +0000252
Jack Jansen4b76ba31997-01-09 16:26:23 +0000253def _test():
Jack Jansen0ae32202003-04-09 13:25:43 +0000254 ic = IC()
255 for k in ic.keys():
256 try:
257 v = ic[k]
258 except error:
259 v = '????'
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000260 print(k, '\t', v)
Jack Jansen0ae32202003-04-09 13:25:43 +0000261 sys.exit(1)
Tim Peters182b5ac2004-07-18 06:16:08 +0000262
Jack Jansen4b76ba31997-01-09 16:26:23 +0000263if __name__ == '__main__':
Jack Jansen0ae32202003-04-09 13:25:43 +0000264 _test()