$Id: readme.txt,v 2.08 2005/07/08 14:19:24 zg0re Exp $

Gbox Suite Plugin by zg0re 

http://zg0re.dvb-z.net/gboxsuite
zg0re@dvb-z.net
ICQ: 155146596 (Contact me with suggestions etc)


You can give this plugin to your friends, but please do not upload it
to public ulcs nor upload images containing it.

Description of the particular functions of the Plugin:

1. Share Info Menu:

a) Share Info (Online Cards): This allows you to view a list of Providers online in the share. 
The Plugin also summarises how many of cards of the particular provider are available.

NEW: Now you can get the details of all cards from this provider by selecting it from the list

b) Online Contacts: This allows you to view a list, which shows who of your contacts is online
with IP and Gbox Version.

c) View Atack.txt: Self-Explanatory, I guess. When you exit the plugin, it asks you, whether you
want to empty the atack.txt.

------------------------------------------------------------------------------------

2. GSMS Menu:

a) Compose GSMS: You can write new GSMS-es here. There are different modes to write a gsms.

	- The standard mode allows you to choose either an online contact, all of them or a single
	   BoxID to send the gsms(es) to.
	- The BoxID Mass Mailing Mode: It will be enabled only if the file /var/keys/boxids.info is 
	   present in your Image. If the file is there, a Button captioned "Mode" will appear. If you press
	   it while in standard mode, you will Change to the Boxid Mass Mailing Mode.
	   Now you can send the GSMS to all the BoxIDs you have in /var/keys/boxids.info or choose a 
	   single boxid. 
	   
	   The File should look like this:
	   
	   ABCD nick 
	   
	   (ABCD is the BoxID which should be 4 characters long. The nick can be anything
	   you want to be associated with this boxid. It will be shown in the dialogue, so
	   you will know who is behind the boxid you're typing to ;))
	
	   --------------------
	   
	   - Enter your message into the four textfields. Each of them represents a line in the resulting gsms.
	      If you choosed the Corresponding option in the Plugin Config Menu, the text of the last gsms you 
	      wrote will be automatically filled into those textfields, so you can simply send your gsms to another 
	      person you have forgot about before, for instance.
	  
	      
b) GSMS Inbox: Simply allows you to read the GSMS(es) you have received.

c) GSMS Outbox: Will be added in near future... ;)

d) Empty GSMS Inbox: Deletes all gsmses if you wish to do so...

------------------------------------------------------------------------------------

3. Gbox Trace:

	You surely know this option from the cwshare tool, now it's also available here :)
	
	To make it work you'll have to do 2 things:
	
	- In /var/keys/gbox_cfg you have to change the Z: Parameter to sth. like this:
	  Z: { 00 12 } 192.168.0.231 8024
	  
	  change 192.168.0.231 to the IP your dream has in your LAN.
	  
	- in /share/tuxbox/enigma/skins/default.esml in the section <fontalias>
	  you have to add this entry:
      
      <map name="eTrace" font="Nimbus" size="16" />
      
      you can choose the font and the size which you would like to have in the plugin.
      I choosed this way so everybody could set his/her ;) favorite font and fontsize.
      
      If you don't have have write access to default.esml you can also insert this into
      the .esml file of your skin.
      
      
    This function is more a proof of concept than a replacemnt for the gbox trace on your
    PC, as it's very hard to follow the output on the small screen ;)


------------------------------------------------------------------------------------

4. Card Information Menu:

a) Upper Slot Card Info: Displays Information about the card you have in the upper Slot of your Box
	   
b) Lower Slot Card Info: Displays Information about the card you have in the lower Slot of your Box

c) Both Slot Info: Displays all cards you have in the box

------------------------------------------------------------------------------------

5. Emu Information Menu: Self-Explanatory...

------------------------------------------------------------------------------------

6. Check Gbox Files: 

This part of the plugin tells you, whether you have all the files necessary to run gbox installed properly.

- Green Symbol means the file is installed - All ok ;)

- Yellow Symbol means that the file has not been found, but it is not absolutely necessary to have it in your 
box to run gbox. But it would be better if you installed this file...

- Red Symbol means that a file necessary to run gbox has not been found. Install it, or you won't be able 
to run gbox properly!

------------------------------------------------------------------------------------

7. Plugin Configuration:

a) Load last gsms when composing new one: Explained in the GSMS Menu section of this readme.

More options to follow soon...

------------------------------------------------------------------------------------

8. Gbox Configuration Menu:

a) General Config: Allows you to change all the options stored in /var/keys/gbox_cfg. Setting the V: and 
    the W: parameters are not yet supported... (But of course they are written to the config ;))
    When you press Save, your actual config file will be copied to gbox_cfg.save, so even if something goes
    wrong while writing the file (Lack of electricity or so... ;)) you'll have a backup.
    
b) CWShare Config 1 (Contacts): Allows you to edit all the contacts (D: and M: Parameters) from cwshare.cfg
    
	- The top line is the M: Parameter. The Hostname should be your Dyndns adress, and the password 
	   you want to have. YOU MUST PRESS THE YELLOW BUTTON TO BE ABLE TO ENTER LETTER A-F!!!
	   
	- The lines after this are representing the D: Parameters. Below is a sample line from cwshare.cfg, so
	   you know which entry is represented by which Textfield in the plugin.
	
					         Ports:		      Sharelevel
		     Hostname:         RX     TX	Password
	   D: { 192.168.0.100 { 1099 1499 { AABBCCDD { 7 7 }}}}
	   
	- Delete Line: Deletes the currently selected line. The function is only available when pressing the red
	    button on your remote. You cannot click the button on the screen. This wouldn't make any sense as 
	    you do not have selected any line then ;)
	    
	- Save: Saves the File, of course with the modification you have made ;)
	    Your actual config file will be copied to cwshare.cfg.save, so even if something goes
            wrong while writing the file (Lack of electricity or so... ;)) you'll have a backup.
	    
	    IMPORTANT NOTE: All other options from cwshare.cfg will be saved as they are, so they are not affected by
	    this part of the plugin (Use CWShare Config 2 to edit those options)
	    
	- Add new line: Adds a new line at the bottom. You only have to enter Hostname and password of your contact.
	     The rest is filled out by default. Please check those values before saving the file.
	     
c) CWShare Config 2: This will be added later, and will allow you to edit the other options contained in cwshare.cfg
				(Everything besides the M: and the D: Parameters)
				
d) SoftCam Config: Allows to change the Softcam Config options, affecting dreambox. Guess the blocker part is the most
important one... Should be self-explanatory
	   
	          

That's all for now 
------------------------------------------------------------------------------------

Changelog:


2.08:

* Gbox Trace Added. IMPORTANT: Please read the instruction in point 3 of this instruction
  _BEFORE_ trying to run it ;)
  
  This function may brake the dbox2 version of this plugin! Please report to me if it does.
  
* Added lock for the OK button for 1 second while entering Share Info to prevent the Card
  Details Window popping up when starting this module.
  
* I won't provide an old cvs version any more, so get yourself a new image if the plugin crashes
  when exiting a dialogue with listbox ;)  

2.07 (internal version):

* fix scrolling in some dialogues... Was a copy&paste error when inserting the
  quickview function in the last version of the plugin

2.06:

* Add Quickview to Peer Status. This will show only if a peer is offline without
  other infos to make it more concise. 
  
  + means Peer ist online
  - means he's offline

  Offline users are displayed on the top.
 
* Add Card Count in the title of the plugin, so you can see how many cards are
  in the share right after starting the plugin. 
  This will look like:
  
  Gbox Suite - 954 Cards
  
* New and more complete ident.info (thanks to the creators of this :))  
  
* Changed order of Peer Status and Atack log as the "g" was cut off before.  
  
* Some relabeling

* Plugin now will be available from the website http://zg0re.dvb-z.net/gboxsuite

2.05:

* Rewritten parts of showFile module (this is the module that shows textfiles (Slot
  Info etc), provider Details and Online Contacts) to make it more stable, as it 
  crashed some times
  
* Many other internal improvements i don't want to bother you with ;)

2.04 (internal version):

* Change scrolling behaviour in Peer Status

2.03 (internal version):

* Change online contacs to Peer Status.
	- Now online and offline peers are shown separately. You can switch the display
	  with green/red
	  
* Other namechanges

2.02 (internal version):

* Add deletion of gsms outbox

* internal code cleanup 

2.01:

* Fix gsms tool (dunno why it wouldn't work on the new cvs... But now it does ;))

* Provide separate plugin version for old cvs (enigma compiled before 05/19/2005)

* Some internal fixes

2.00:

* Completely rewritten Share Info. Should be faster, less memory consuming and you can see Details for a provider now, when selecting 
one from the list

* Still didn't have time to investigate into the gsms matter, but in the next version it will be fixed ;)

1.95:

* Recompile for new cvs. GSMS writing somehow doesn't work - don't have time to check what's wrong atm :(

1.94:

* Improve sorting algorithm. Should be now faster and Ignoring case, so everything should be sorted as expected ;)

* Also sort the Boxids in compose gsms, to make it easier to find the desired boxid. It's sorted from 0-F

1.93:

Thought about the messaging mode by boxid and came to the conclusion that it does not make too much sense as it was, so i modified it.

Now the boxid messaging mode is also accessible when you don't have the boxids.info file, as the boxids available to send a message to
are now taken directly out of share.info! So you can basically message every box in your share, that has a card by choosing it's boxid.

But you still can have the /var/keys/boxids.info file in your image. For what you're asking now... Well you can attach a nick to a certain boxid in
this file and this nick will be displayed in the GSMS dialogue when you choose the corresponding boxid.

If you do not have this file or if it does not contain the chosen boxid, you will only see "This boxid is not known" in the plugin.

ATTENTION:

I changed the format of the /var/keys/boxids.info file, to make it easier for me to parse (call me lazy... ;))

It now looks like this:

ABCD;Nickname (ABCD is the boxid the Nickname should be attached to). 

So i simply changed the space which was there before to a semicolon. Please update your file accordingly, or you will experience problems ;)

1.92:

Added Gsms Outbox menu. It will _NOT_ read gbox's own gsms out file gsms.ack, but it will get the sent messages from lastgsms.txt,
which is stored when you send a message using this plugin. This file will store all gsmes, sent along with text and whom you sent to. 
I choosed this method, cause gsms.ack does not contain the gsmses text so it wouldn't make sense to have a GSMS outbox without
displaying the text of the sent messages ;)

ATTENTION: This function is _NOT_ affected by the setting in plugin configuration. It will work also when you disable this option!

1.91:

* Competely rewritten the Share Info module backend. You do not need to have sort in the busybox of your image. The sorting of
the providers by name now is done by an internal quicksort algorithm in the plugin. 

* Change used char variables to two dimensional char arrays in some places to get rid of malloc() and free(). This also busts some 
potential memleaks

* remove uneeded code

1.90:

Added the Softcam Config Menu. Now only cwshare.cfg part 2 is missing :)

1.89:

* Replace Messagebox asking if you want to clear atack.txt with a normal button, as the eventhandler somehow
  did not word as it should :(

* As i have noticed gbox can only send 50 gsms from one gsms.txt, so had to change behaviour when mass smsing by
  boxids. You will be noticed how long sending will take!

1.88:

* Added Full Config for gbox_cfg

* Add statusbars all over the plugin, to display some hints...

1.87:

Rewritten CWShare Config 1, as it could only display about 10 entries before. Now you can edit a virtually
unlimited amount :)

1.86:

Added CwShare Config 1

1.85:

* Fixed some smaller bugs in the whole plugin.
* Refactorize parts of the plugin to make it smaller and faster

1.84:

* Fixed bug in displaying Last Gsms - Only one word per line was visible
* If you have /tmp/lastgsms.txt generated by 1.82, or 1.83 in your image, 
  please delete it, as it could cause problems

1.83:

Add Plugin Config Menu. 

For now it has one entry, which allows you to disable/enable the option 
introduced in 1.82

1.82:

Add displaying last written gsms in the GSMS Compose tool. Now the text of
the gsms you have written last time will be displayed in the corresponding
fields.
This will allow you to send the same message to other people, whom you have 
forgot before for example.

1.81:

Add possibility to send GSMS-es to BoxIDs read from /var/keys/boxids.info.
The file should look like this:

ABCD nick 

(ABCD is the BoxID which should be 4 characters long. The nick can be anything
you want to be associated with this boxid. It will be shown in the dialogue, so
you will know who is behind the boxid you're typing to ;))

The BoxID Mass Mailing (c) ;) Mode will be only enabled if the file named above is found! Then there will appear a Button called Mode. Press it (or the yellow button on your remote ;)) to change to BoxID Mass Mailing Mode (and if in this mode - to return to Normal Mode). I think the rest should be self explanatory ;)

1.80:

Another Bug in GSMS Reader has been fixed. 

1.79:

Fixed Silly bug, which caused that only the first word of a line in gsms has been read

1.78:

* As promised, i have added splitting lines accordingly :D

1.77:

* Added GSMS Reader (Still beta...)
	TODO: Split lines if / is found in message
* ident.info updated, so more providers will be listed by name

1.76:

Added Online contacts display

1.75:

Change contact choose mode in GSMS Tool to Listbox, as the combobox
was not useable with many contacts online...

1.74:

Update the Menus

1.73:

- Show online online contacts in GSMS tool (Before, all contacts from
cwshare where shown...)
- Rewrote some code
- Fixed a possible memleak
- Some internal fixes...

1.72:

- Fixed nasty Bug, that made the gsms tool crash
This plugin allows to view many infos about gbox and many more ;)

1.71:

- Introduced the new Menu structure
- Make filecheck more dynamic: No problem to add new files to be checked now

1.7:

- Introduced the Filecheck dialogue
- Fixed severe bug: Destructors where not executed, so memleaks could appear

1.6:

Introduced GSMS Tool

1.5:

don't remember ;)

1.4:

- It's now possible to save the share info to a File

1.3:

Port the Plugin to dbox2, both versions are now using the same development tree

1.2:

Introduced the Mainmenu and emu + card info

1.1:

- Rewrote the whole plugin, as i wanted the share info to appear in a 
listbox, instead of a label as before
- Plugin now uses ident.info to translate provids to real names ;)

1.0:

First Version, only Share Info available

