SurgeWeb Advanced Customisation

You can enable the extension css and javascript instead. These will allow you to override any surgeweb core CSS declarations or replace any native surgeweb javascript functions. You can customise any core surgeweb javascript function. Either by replacing it or more likely "hook" them by providing your own intermediate level of functionality which then calls the core surgeweb code in order to do the core interface actions.

If netwin staff are troubleshooting your system for surgeweb problems and advanced customisation has been applied, one of the first tests will be to test with customisation disabled. This will preferably be done using the surgemail.ini setting surgeweb_custom for this purpose, or if necessary by copying the original files back into the surgeweb/tpl directory.

Here is a list of things other admins have wanted to do. If you do them as described below they will remain intact on surgemail upgrades:

I don't want users to adjust their advanced preferences

The advanced options and customisation pane in the preferences will not be displayed if you add this to any config_*.dat file:

 lock_options_basic true

Users should not be able to modify their reply name

To any config_*.dat file add:

 lock_name_auth true

I always want the quota displayed

A quota warning will be displayed if you go over 80%, this is normally hidden to keep the interface clean. This can be always shown by adding this to any config_*.dat file:

 always_show_quota true

Display filestore as well as / instead of photos button in application menu

In extend.css add the relevant style definitions below:

 #app_filestore{
 	display:block;
 }
 #app_photos{
 	display:none;
 }

Remove Calendar / Photos / Blogs Application menu buttons

Calendar and photos can be hidden by disabling surgeplus using the surgemail.ini setting:

 g_disable_surgeplus "TRUE"

or by using user_access settings

!surgeplus

Blogs can be hidden using the user_access setting

 !blogs

Remove the remember me login box on the front login page

In extend.css add:

 #remember_me{
 	display:none;
 }

I want the help links to point at my own website

Setup your own pages of the same name and point all the surgeweb help links at that using the follwoing setting in any config_*.dat file:

 help_url http://mywebsite.com

I want a shared addressbook to be displayed

A variety of options are available for shared addressbooks. Either Global / Domain surgeweb addressbooks or LDAP or Authentication database based addressbooks. These are configured using the abook page in the surgemail admin interface:

 abook name="Global" read="!*" write="!*" type=""
 abook name="Domain" read="!*" write="!*" type=""
 abook name="LdapAbook" read="*" write="" type="ldap"
 abook name="AuthentAbook" read="*" write="" type="auth"
 abook name="Surgeweb" read="*" write="" type=""

I do not want any shared addressbooks to be displayed

Make sure the users do not have access to any addressbooks you have defined in surgemail.ini. To remove the Global and Domain addressbooks set:

 abook name="Global" read="!*" write="!*" type=""
 abook name="Domain" read="!*" write="!*" type=""

I do not want to offer labels in surgeweb

Labels functionality can be disabled by adding this to any config_*.dat file:

 labels_disable true

I want different / no default groups in the contacts management

The default groups can be defined using this setting in any config_*.dat file:

 contact_groups Friends,Family,Colleagues

or

 contact_groups Foo,Bar

or

 contact_groups

I want to remove the raw user.cgi settings

The raw user.cgi settings on the "Options - Preferences - Filtering and Spam Control" page already get hidden if g_user_access / user_access settings are used to disable spam handling. To always hide, add this to extend.css:

 .raw_user_cgi{
 	display:none;
 }

Remove surgeweb spam handling disabled warning

The warning "some SurgeWeb spam control options disabled by administrator" is displayed on the "Options - Preferences - Filtering and Spam Control" page if the recommended surgemail spam handling techniques have been disabled. If for example you have your own spam handlign technniques in place, this wanring can be removed by adding this to extend.css:

 #opt_fs_disabled_warn{
 	display:none;
 }

Remove processing actions on Filtering and Spam control Page

This functionality can be enabled / disabled using g_user_access / user_access / the authentication databse user_access fields and they will be removed from display in surgeweb:

 relevant fields: fwd, fdwonly, exceptions, friends, spam

Remove the processing actions link

To remove the "Check the delivery log for a record of processing actions" link on the "Options - Preferences - Filtering and Spam Control" page, add this to extend.css:

 #opt_fs_log{
 	display:none;
 }

Remove the display of running surgemail version

To remove the "Options - Preferences - Advanced" page current surgemail version, add this to extend.css:

 #opt_adv_version{
 	display:none;
 }

Modify the banner image in mobile interface

 config_domain.dat add:
      mobile_custom_banner true
 and you place your modified logo image in
      surgeweb/custom/banner_mobile.jpg
 or
      surgeweb/custom/your_domain/banner_mobile.jpg

I want the change password button to go to my own interface

Enable extend.js and enable this code:

 # Hook the usercgi dialog function to do some of our own handling instead
 if(true){
     hook_user_cgi_dlg();
 }
 # Store original function and replace with our own one. In this case do our own action if it was the password button
 var user_cgi_dlg_orig;
 function hook_user_cgi_dlg()
 {
     user_cgi_dlg_orig=user_cgi_dlg;
     user_cgi_dlg=function(type){
         if (type=='password'){
             open_popup2('https://my.server.name/public/changepass.aspx');
             return;
         }
         user_cgi_dlg_orig(type);
     }
 }
 

I want to hide the change password button

There are two ways. Either set !pass in the accounts user_access settings in the authentication database, or add this to extend.css:

 #opt_gen_change_password{
 	display:none;
 }

I want my own link(s) to the right of the username at the top of the page

Add this to extend.js.

 var node=dge('link_bar').childNodes[2];
 var frag=document.createElement('span');
 frag.innerHTML=' <a href="http://netwinsite.com">MyLink</a> | ';
 node.parentNode.insertBefore(frag,node);

I want to customise the folder icon

Add an appropriate image to your custom directory and then add a rule with appropriate offsets to extend.css. (currently the default file you may want to base your icons on is surgemail\surgeweb\tpl\shared\img\vbtn_icons.gif)

 .folder_icon{
    background: url(vbtn_icons.gif?||vz||) no-repeat 0 -80px;
 }

I want to change the folder list text colors

This may yet be changed to simplify it but adding these to custom.css will allow you to customise this currently.

# Base folder name colours
 ul.ftree{
    color:blue;
 }

# Colors associated with folder list selection handling
 .ftree .selected, .ftree .hover_js, .ftree .hover_js a, .ltree .selected, .ltree .hover_js {
    color:blue;
 }
 ul.ftree .selected a {
    color:blue;
 }
 #folders .part_cursor:hover, #folders .part_cursor:hover a {
    color:blue;
 }

# Labels and Searches text color
 .green_text{
    color:blue;
  }

What else can I do with this?

Here is an example of a very different application menu. The menu has been moved to the topleft instead of bottom left and is image based. To try this, enable extend.css and extend.js, then uncomment this is code in extend.js:

 if(true){
     move_panel_to_top('app_menu')
     alternate_menu();
 }

Or alternatively here the creation of panels on the left say with your own content in it. Here are several examples from extend.js:

 #	New fancy panel at the bottom with title and body text. Again can have anything in it
 new_panel_fancy('My own panel header', 'Fancy panel body with anything in it','bottom');

 #	New fancy panel at the bottom with live maps as an example
 var content='<iframe id="a_map" src="http://wikimapia.org/s/#lat=-40.7805414&lon=173.8476563&z=4&l=0&m=a&v=1"
		 width="'+lc_width()+'" height="200" frameborder="0" style="background:||lpanel_color||"></iframe>';
 new_panel_fancy('Wikimapia!! <i><a href="http://wikimapia.com"
		 target="_popup">link</a></i>',content,'bottom',true);

 #	New fancy panel at the bottom with youtube content as an example
 var content='<object width="'+lc_width()+'" height="200"><param name="movie"
         value="http://www.youtube.com/v/Pfs4Rd5f_IQ&hl=en&fs=1"></param>'+
         '<param name="allowFullScreen" value="true"></param>'+
         '<embed src="http://www.youtube.com/v/Pfs4Rd5f_IQ&hl=en&fs=1"
         type="application/x-shockwave-flash" allowfullscreen="true"'+
         ' width="'+lc_width()+'" height="200"></embed></object>';
 new_panel_fancy('Youtube!!',content,'bottom',true);

Anyway, as I said at the start of the page. Any customisation done this way will remain intact on surgemail upgrades. Please contact us on surgemail-support@netwinsite.com if you have something you feel you need to customise and currently cannot, explainng exactly what you want to do and why.

Marijn