home *** CD-ROM | disk | FTP | other *** search
/ BUG 11 / BUGCD1998_02.ISO / email / sime / startup.tcl < prev    next >
Text File  |  1997-12-09  |  15KB  |  367 lines
  1. # MODULE[data]: new_user_startup - All platforms
  2.  
  3. # FUNCTION
  4. # This file is used to query for information that is user specific and 
  5. # not provided in the sysdflt.tcl file.   It is only run the first time
  6. # the user runs Simeon.
  7. # END FUNCTION
  8.  
  9.  
  10. # NOTES
  11. # The intent for this file is to ask new user's whatever questions 
  12. # are needed to complete the initialization their Simeon configuraton.
  13. # The file is run if (and only if) after loading the site default
  14. # file "sysdflt.tcl", we were unable to load a user configuration.
  15. # The test for seeing if the user configuration was loaded is the
  16. # existence (or lack thereof) of the option "General.Fullname".
  17. # Because this option is user specific, the only way that we would
  18. # actually get this option was to have run this file.
  19. #
  20. # As a result, if you (the system administrator) modifies this file,
  21. # then you had better make sure that "General.Fullname" is set into
  22. # the user's configuration after they are done with it.
  23. #
  24. # The file is a Tool Command Language (TCL) file that contains a set of
  25. # "option" commands.  The "option" command is a Simeon extension to TCL
  26. # that supports updating the content of the Simeon runtime option
  27. # (configuration) database.  The file can contain any of the standard
  28. # TCL commands and statements.
  29. #
  30. # Options are defined using the following syntax:
  31. #
  32. #  "option [-default | -permanent | -session] [-readonly] {name} [{value}]
  33. #
  34. # where arguments in the [] are optional, and arguments in {} are
  35. # variables that are provided by you.  If just the option {name} is
  36. # provide with no {value}, then value of the option is returned.  If the
  37. # {name} and {value} are provided, then the value is stored in the
  38. # runtime option database.
  39. # 
  40. # Options can be stored in one of three levels: default, permanent, and
  41. # session.  When options are referenced in the repository, a session
  42. # value is retrieved ahead of a permanent value, and a permanent value
  43. # is retrieved ahead of a default value.  Therefore, a session value
  44. # will "mask" a permanent value which will "mask" a default value.  Only
  45. # permanent values are saved from the option database to the user's
  46. # permanent option repository.
  47. # 
  48. # The file also makes use of a set of user interface extensions to TCL
  49. # that allows you to put up dialogues and ask questions of the user.   A
  50. # procedure named "askQuestion" has been defined that can be used to ask
  51. # any one line question of a user on the way in.  
  52. # END NOTES
  53.  
  54. # HISTORY
  55. # IncrDev Jul 11, 1997 by ll: added code to test for sysdflt version.
  56. # IncrDev Jul 10, 1997 by ll: combined startup.demo into this file and
  57. #                             incorporated the getInstallData procedure
  58. # IncrDev Feb 4, 1995 by ll: modified defaultRemainder to only default
  59. #                            ms2.hostname (News Host) if it is still set
  60. #                            to the factory default of "newshost"
  61. # IncrDev Jan 9, 1997 by ll : added getDemoUserID, defaultDemoMailAddress
  62. #                             procs
  63. # IncrDev Dec 23, 1996 by ll: changes for 4.1. Enhanced documentation.
  64. # IncrDev May 6, 1996 by ll: added default for Page Layout footer to contain
  65. #                            the user's full name as entered during startup
  66. # IncrDev Mar 12, 1996 by ll: added documentation and added IMSP and
  67. #                             signature defaults in proc DefaultRemainder
  68. # IncrDev Mar 12, 1996 by ll: added code in proc askQuestion to not
  69. #                             select the field if it contains @domain.name
  70. # IncrDev Mar 7, 1995 by ll: added code to default to default to option
  71. #                            in sysdflt.tcl file. If not set, THEN default
  72. #                            to Post Office (IMAP) answer 
  73. # IncrDev Dec 28, 1995 by ll: put back other hostname questions but defaulted
  74. #                             answers to the Post Office answer
  75. # IncrDev Dec 28, 1995  by ll: added selection on input field
  76. # IncrDev Nov 2, 1995 by sh: to only ask one hostname question and default others
  77. # Doc____ Nov 5, 1995 by sh: first cut of new documentation
  78. # IncrDev Nov 1, 1995 by sh: added default View options for new users
  79. # END HISTORY
  80.  
  81. if {[info exists sysdflt_version] == 1} {
  82.    if {$sdlog == "yes"} {
  83.       debug_trace "startup.tcl : begin"}
  84.       debug_trace "startup.tcl : guest = $guest"
  85. } else {
  86. # sysdflt.tcl from version earlier than 4.1.2 so 
  87. # initialize variables.
  88.    set sdlog "no"
  89.    set guest "no"
  90.    debug_trace "startup.tcl : sysdflt.tcl file from 4.1.1 or earlier."
  91. }
  92.  
  93. # : This function is called from Simeon, to kick off the 
  94. # : process
  95.  
  96. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare startSetup"}
  97.  
  98. proc startSetup {} {
  99.     global sdlog
  100.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin startSetup"}
  101.     label t1 -parent startupwin -left 20 -top 60 -right 370 -bottom 80 \
  102.        -title "You'll need to provide a bit of information to start."
  103.     getUserName
  104. }
  105.  
  106. # : askQuestion is called in the following routines to prompt the user
  107. # : for IMAP host, SMTP host, and IMSP (Address book) host.
  108. # : The nextcmd parameter contains the procedure name of the next
  109. # : question to be asked. If you wish to skip a question  from this
  110. # : list, modify the previous routine's call to askQuestion as described
  111. # : in the documentation for the verifyAddrBookHost routine below.
  112.  
  113. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare askQuestion"}
  114.  
  115. proc askQuestion {win nextcmd prompt initval example option} {
  116.     global sdlog
  117.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin askQuestion"}
  118.     set w startupwin.$win
  119.     frame $w -parent startupwin -left 10 -top 100 -right 390 -bottom 290 \
  120.        -entercommand "option $option \[get_ctl_title $w.resp\]; hide_win $w; $nextcmd"
  121.     label $w.t1 -parent $w -left 20 -top 30 -right 370 -bottom 50 -title $prompt
  122.  
  123.     edit $w.resp -parent $w -left 30 -top 60 -right 360 -bottom 80 \
  124.        -title $initval -command ""
  125.     focus $w.resp
  126.     if { $initval != "" } {
  127. #       if {$initval != "simeon"} {
  128.       if {[string index $initval 0] != "@" } {
  129.          select $w.resp
  130.       }
  131. #       }
  132.     }
  133.     label $w.ex -parent $w -left 30 -top 100 -right 360 -bottom 120 -title $example
  134.     button $w.done -parent $w -left 135 -top 160 -right 195 -bottom 180 -title "OK" \
  135.        -command "option $option \[get_ctl_title $w.resp\]; hide_win $w; $nextcmd"
  136. }
  137.  
  138. # FUNCTION
  139. # : Ask for the user's full name. No default should be supplied from
  140. # : sysdflt.tcl Simeon checks for the presence of this option to determine
  141. # : whether it should run this script.
  142. # END FUNCTION
  143. #
  144. # HISTORY
  145. # IncrDev July 10, 1997 by ll: if a guest account set the next command
  146. #                              to get the DemoUserID rather than getMailAddress
  147. # END HISTORY
  148.  
  149. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare getUserName"}
  150.  
  151. proc getUserName {} {
  152.  
  153.     global sdlog
  154.     global guest
  155.  
  156.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin getUserName"}
  157.     if {$guest == "yes"} {
  158.        askQuestion name getDemoUserID "What is your full name?" \
  159.       "" "e.g. Bill Smith" General.Fullname
  160.     } else {
  161.        askQuestion name getMailAddress "What is your full name?" \
  162.       "" "e.g. Bill Smith" General.Fullname
  163.     }
  164. }
  165.  
  166. # : Ask for user's email address.
  167. # : General.MailDomain from sysdflt.tcl is defaulted into this field.
  168. # : If the sysdflt.tcl contains "simeon.com" the user will see
  169. # : @simeon.com and the cursor placed ahead of the @ when this question
  170. # : is asked.
  171.  
  172. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare getMailAddress"}
  173.  
  174. proc getMailAddress {} {
  175.     global sdlog
  176.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin getMailAddress"}
  177.     set init ""
  178.     catch {set init "@[option General.MailDomain]"}
  179.     if { $init=="@"} {set init ""}
  180.     askQuestion email verifyMailHost "What is your email address?" \
  181.        $init "e.g. userid@company.com" General.MailAddress
  182. }
  183.  
  184. # : Ask for user's demo account user id.
  185. # : Only used for demo guest account installations.
  186.  
  187. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare getDemoUserID"}
  188.  
  189. proc getDemoUserID {} {
  190.     global sdlog
  191.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin getDemoUserID"}
  192.     set init ""
  193.     askQuestion email defaultDemoMailAddress \
  194.        "Enter your Simeon guest account username" \
  195.        $init "e.g. bsmith" General.MailAddress
  196. }
  197.  
  198. # : Get the host name of the mail server.
  199. # : This is the Post Office message service host name and is the server
  200. # : running an IMAP2bis or IMAP4 daemon.
  201. # : NOTE: if the setting in sysdflt.tcl is correct and does not need to
  202. # : be changed by the user, this question can be omitted. See the comments
  203. # : under Verify Address Book Host for information on how to skip a startup
  204. # : question.
  205.  
  206. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare verifyMailHost"}
  207.  
  208. proc verifyMailHost {} {
  209.     global sdlog
  210.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin verifyMailHost"}
  211.     set init ""
  212.     catch {set init [option MsgService.ms1.Hostname]}
  213.     askQuestion email verifySMTPHost \
  214.        "What is your Post Office (IMAP) server hostname?" \
  215.        $init "e.g. mailhost.company.com" MsgService.ms1.Hostname
  216. }
  217.  
  218. # : Verify SMTP Host
  219. # : General.DeliveryHost from sysdflt.tcl is defaulted into this field.
  220. # : If this field has not been initialized in sysdflt.tcl (ie. still
  221. # : set to "mailhost") default it to the IMAP host instead.
  222. # : NOTE: if the setting in sysdflt.tcl is correct and does not need to
  223. # : be changed by the user, this question can be omitted. See the comments
  224. # : under Verify Address Book Host for information on how to skip a startup
  225. # : question.
  226.  
  227. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare verifySMTPHost"}
  228.  
  229. proc verifySMTPHost {} {
  230.     global sdlog
  231.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin verifySMTPHost"}
  232.     set init ""
  233.     catch {set init [option General.DeliveryHost]}
  234.     if {$init == "mailhost"} {
  235.     catch {set init [option MsgService.ms1.Hostname]}
  236.     }
  237.     askQuestion email verifyAddrBookHost \
  238.        "What is your mail sending (SMTP) server hostname?" \
  239.        $init "e.g. smtphost.company.com" General.DeliveryHost
  240. }
  241.  
  242.  
  243. # : Verify Address Book Host
  244. # : AddrBook.Hostname from sysdflt.tcl is defaulted into this field.
  245. # : By default this is field is empty in sysdflt.tcl because a value in
  246. # : this field indicates to Simeon that an IMSP host is available and
  247. # : Simeon will search for remote address books when the address book
  248. # : module is started up. For this reason, we do not default this field
  249. # : to the Post Office host.
  250. # : If your site does not run IMSP or will not be using IMSP addressbooks
  251. # : you will not want to ask this question of new users. To eliminate
  252. # : this question from being asked, modify the following line in 
  253. # : verifySMTPHost
  254. # :    askQuestion email verifyAddrBookHost "What is your mail sending...
  255. # : to read
  256. # :    askQuestion email defaultRemainder "What is your mail sending...
  257. # : This causes defaultRemainder to be run after verifySMTPHost instead
  258. # : of verifyAddrBookHost. This mechanism can be used in any of the 
  259. # : verify routines to eliminate a question or to reorder them.
  260. # : You can also write a new routine and add it to the list if you wish.
  261.  
  262. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare verifyAddrBookHost"}
  263.  
  264. proc verifyAddrBookHost {} {
  265.     global sdlog
  266.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin verifyAddrBookHost"}
  267.     set init ""
  268.     catch {set init [option AddrBook.Hostname]}
  269.     askQuestion email defaultRemainder \
  270.        "What is your address book (IMSP) server hostname?" \
  271.        $init "e.g. addrhost.company.com" AddrBook.Hostname
  272. }
  273.  
  274. # : Default demo account mail address. If this routine is called, it
  275. # : is assumed that the user id is an ESYS guest account id and will
  276. # : append the ESYS demo server domain onto the mail address.
  277. # : Called only from getDemoUserID
  278.  
  279. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare defaultDemoMailAddress"}
  280.  
  281. proc defaultDemoMailAddress {} {
  282.     global sdlog
  283.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin defaultDemoMailAddress"}
  284.  
  285. # : Set userid in Post Office Message Service
  286.     option MsgService.ms1.Userid [option General.MailAddress]
  287.  
  288. # : Add demo domain to General.MailAddress
  289.        option General.MailAddress [option General.MailAddress]@demo.simeon.com
  290.  
  291.     defaultRemainder
  292. }
  293.  
  294. # : Perform other default actions
  295. # : Note that "doneECSStartup" is a magic token that says ask no
  296. # : more questions.   You must use that token exactly to terminate the question
  297. # : string. 
  298.  
  299. # HISTORY
  300. # Oct 17, 1997 by ll: commented out setting of Reply-To variable
  301. # END HISTORY
  302.  
  303. if {$sdlog == "yes"} {debug_trace "startup.tcl : declare defaultRemainder"}
  304.  
  305. proc defaultRemainder {} {
  306.     global sdlog
  307.     if {$sdlog == "yes"} {debug_trace "startup.tcl : begin defaultRemainder"}
  308.  
  309. # : Default the News host name to that of the Post Office
  310.  
  311.     if {[option MsgService.ms2.Hostname] == "newshost"} {
  312.     option MsgService.ms2.Hostname [option MsgService.ms1.Hostname]
  313.     }
  314.  
  315. # : Default the user's signature to his full name and email address
  316.  
  317.     option Compose.Signature.Lines "3"
  318.     option Compose.Signature.1 "----------------------"
  319.     option Compose.Signature.2 [option General.Fullname]
  320.     option Compose.Signature.3 [option General.MailAddress]
  321.  
  322. # : default the user's Reply-To address to be the same as his
  323. # : email address
  324. # : ReplyTo should only be set if it will be different than
  325. # : From address, so we no longer do this
  326.  
  327. #    option General.ReplyTo [option General.MailAddress]
  328.  
  329. # : default print page footer to contain user's name
  330.  
  331.     option PageLayout.Footer "l 'Printed by: [option General.Fullname]' c 'Page: ' \$page"
  332.  
  333. # : Default the IMSP options hostname to that given for the Address book
  334. # : with the assumption that the the same IMSP host will be used for both.
  335. # : If no IMSP host then these options will just be blank. 
  336.  
  337.     option -session Options.RemoteHost [option AddrBook.Hostname]
  338.     option -session Options.RemotePort [option AddrBook.TCPPort]
  339.  
  340. # : Done the startup script.
  341.  
  342.     doneECSStartup
  343. }
  344.  
  345. # : define default views for new users
  346. # : A first time user will inherit these settings into their personal
  347. # : options file.
  348.  
  349. option FOLDER.ID "1"
  350. option Folder.1.IsSelecting "OFF"
  351. option Folder.1.MS "1"
  352. option Folder.1.Name "inbox"
  353. option Folder.1.ViewMsgGrps "OFF"
  354. option Folder.1.inbox.ID "1"
  355. option Folder.1.inbox.Sort "Most Recent Date Sent"
  356.  
  357. if {$sdlog == "yes"} {debug_trace "startup.tcl : calling startSetup"}
  358.  
  359. # : initiate setup scripts 
  360. startSetup
  361.  
  362. if {$sdlog == "yes"} {debug_trace "startup.tcl : end"}
  363.  
  364. # END MODULE: new_user_startup - All platforms
  365.  
  366.  
  367.