cdbak-0.1.0/ 40775 764 764 0 6712051222 11205 5 ustar steve steve cdbak-0.1.0/doc/ 40775 764 764 0 6712051222 11752 5 ustar steve steve cdbak-0.1.0/doc/cdbak.html 100664 764 764 13300 6712045776 14037 0 ustar steve steve
CD backup utility
Contents
1.
Introduction
This CD backup utility allows you to select from a number of backup
profiles that you previously defined and uses mkisofs and cdrecord
to actually write them to the CD.
It is not intended to be a general purpose interface for burning CD's, for
which there are a number of other excellent programs.
1.1
Future directions
This is an initial release, so only has the basic functionality.
Improvements would include allowing it to deal with incremental backups
and using multi session support to place them onto one CD.
2.
Configuration
First the file
/etc/cdbak.conf
is read if it exists.
Followed by
~/.cdbak.conf
and
$CDBAK.
The contents of these files are merged with the later ones overriding
the contents of earlier ones.
2.2
Specifying backup profiles
The configuration file contains a number of backup profiles.
These consist of a set of directories to backup and various other
parameters that control the backup.
Each section in the file begins with the profile name in square brackets.
Following this are a number of parameters that control the backup.
For example:
[SYSTEM]
backup:
dir /boot
dir /etc
dir /root
dir /var
Here we have a profile named
SYSTEM
that specifies that everything under
/boot,
/etc,
/root
and
/var
will be backed up.
2.2.1
Backup directory list
The word
backup
is followed by a colon and then all following lines beginning
with spaces.
The
backup
item takes a series of
dir
commands; one per line for each directory that is to be backed up.
2.2.2
Controlling the directory layout on the CD
By default, files are placed on the CD at the same path as they
exist on your disk.
To change this you can place a second directory name after the first
which will become the name that is used on the CD.
#
# In this example, with the following specification, the file /etc/termcap
# would be written on the CD as /new/etc/termcap
#
backup:
dir /etc /new/etc
2.2.3
Excluding parts of the directory tree
Quite often there will be directories that you know
should not be backed up as they contain temporary files or files
that can be easily re-created.
You can exclude these with the
except
command in the configuration file.
[HOME]
#
# In this example everything under /home/steve is to be backed up
# apart from the directories build, tmp and kern.
# Also everything in the .netscape/cache and .netscape/xover-cache
# directories are excluded.
#
backup:
dir /home/steve, except build, except tmp,
except kern,
except .netscape/cache,
except .netscape/xover-cache
After
dir
is a comma and then the word
except
followed by a directory to exclude.
This directory is relative to the one given by
dir.
For example
dir /A , except B/C
would exclude
/A/B/C
from the backup.
Lines ending in a comma are continued on the next line.
2.3
The DEFAULT section
The default section is special and is not the name of a backup
profile.
In the
DEFAULT section you can place all parameters that do not change from
profile to profile.
If a parameter occurs in the
DEFAULT section and in a profile, then the value in the profile will be used.
- output
-
The file name that the backup is written to.
This file will be up to the size of a CD (650MB) and so should be on
a partition that has plenty of space.
output: /temp/backup.raw
- application_id
-
This is the name that will be put onto the CD header.
You can use it to identify the backup, and in this case
it should probably be overridden in each section.
- rockridge
-
Use Rock Ridge format. This should be set to
yes
unless you have a good reason not to.
rockridge: yes
- rockridge_dist
-
This passes the
-r
option to
mkisofs
rather than
-R.
See the
mkisofs
documentation for exact details of what it does.
Basically this option is more useful for distributing software as
all the ownership and file mode information is removed.
For you own backups you would usually set this to
no.
- device
-
This is the device name that will be passed to
cdrecord.
See the
cdrecord
documentation for this.
device: 0,0
- speed
-
The CD writing speed.
speed: 2
cdbak-0.1.0/doc/cdbak.mm 100664 764 764 10400 6712045776 13502 0 ustar steve steve .de Cs
.DS I
.ft C
..
.de Ce
.ft R
.DE
..
.de C
\fC\\$1\fP\\$2
..
.ds HF B B B
.ds HP +3 +2 +1
.ds #T "CD backup utility
.ds #C y
.H 1 "Introduction
This CD backup utility allows you to select from a number of backup
profiles that you previously defined and uses mkisofs and cdrecord
to actually write them to the CD.
.P
It is not intended to be a general purpose interface for burning CD's, for
which there are a number of other excellent programs.
.H 2 "Future directions
This is an initial release, so only has the basic functionality.
Improvements would include allowing it to deal with incremental backups
and using multi session support to place them onto one CD.
.H 1 Configuration
.H 2 Files
First the file
.C /etc/cdbak.conf
is read if it exists.
Followed by
.C ~/.cdbak.conf
and
.C $CDBAK .
The contents of these files are merged with the later ones overriding
the contents of earlier ones.
.H 2 "Specifying backup profiles"
The configuration file contains a number of backup profiles.
These consist of a set of directories to backup and various other
parameters that control the backup.
.P
Each section in the file begins with the profile name in square brackets.
Following this are a number of parameters that control the backup.
For example:
.Cs
[SYSTEM]
backup:
dir /boot
dir /etc
dir /root
dir /var
.Ce
Here we have a profile named
.I SYSTEM
that specifies that everything under
.C /boot ,
.C /etc ,
.C /root
and
.C /var
will be backed up.
.H 3 "Backup directory list
The word
.I backup
is followed by a colon and then all following lines beginning
with spaces.
The
.I backup
item takes a series of
.I dir
commands; one per line for each directory that is to be backed up.
.H 3 "Controlling the directory layout on the CD
By default, files are placed on the CD at the same path as they
exist on your disk.
To change this you can place a second directory name after the first
which will become the name that is used on the CD.
.Cs
#
# In this example, with the following specification, the file /etc/termcap
# would be written on the CD as /new/etc/termcap
#
backup:
dir /etc /new/etc
.Ce
.H 3 "Excluding parts of the directory tree"
Quite often there will be directories that you know
should not be backed up as they contain temporary files or files
that can be easily re-created.
.P
You can exclude these with the
.I except
command in the configuration file.
.Cs
[HOME]
#
# In this example everything under /home/steve is to be backed up
# apart from the directories build, tmp and kern.
# Also everything in the .netscape/cache and .netscape/xover-cache
# directories are excluded.
#
backup:
dir /home/steve, except build, except tmp,
except kern,
except .netscape/cache,
except .netscape/xover-cache
.Ce
.P
After
.I dir
is a comma and then the word
.I except
followed by a directory to exclude.
This directory is relative to the one given by
.I dir .
For example
.C "dir /A , except B/C"
would exclude
.C /A/B/C
from the backup.
Lines ending in a comma are continued on the next line.
.H 2 "The DEFAULT section
The default section is special and is not the name of a backup
profile.
In the
.SM DEFAULT
section you can place all parameters that do not change from
profile to profile.
If a parameter occurs in the
.SM DEFAULT
section and in a profile, then the value in the profile will be used.
.VL 20 0
.LI output
The file name that the backup is written to.
This file will be up to the size of a CD (650MB) and so should be on
a partition that has plenty of space.
.Cs
output: /temp/backup.raw
.Ce
.LI application_id
This is the name that will be put onto the CD header.
You can use it to identify the backup, and in this case
it should probably be overridden in each section.
.LI rockridge
Use Rock Ridge format. This should be set to
.I yes
unless you have a good reason not to.
.Cs
rockridge: yes
.Ce
.LI rockridge_dist
This passes the
.C -r
option to
.I mkisofs
rather than
.C -R .
See the
.I mkisofs
documentation for exact details of what it does.
Basically this option is more useful for distributing software as
all the ownership and file mode information is removed.
For you own backups you would usually set this to
.I no .
.LI device
This is the device name that will be passed to
.I cdrecord .
See the
.I cdrecord
documentation for this.
.Cs
device: 0,0
.Ce
.LI speed
The CD writing speed.
.Cs
speed: 2
.Ce
cdbak-0.1.0/doc/cdbak.txt 100664 764 764 12776 6712045776 13732 0 ustar steve steve
1. Introduction
This CD backup utility allows you to select from a number
of backup profiles that you previously defined and uses
mkisofs and cdrecord to actually write them to the CD.
It is not intended to be a general purpose interface for
burning CD's, for which there are a number of other excellent
programs.
1.1 Future directions
This is an initial release, so only has the basic functionality.
Improvements would include allowing it to deal with incremental
backups and using multi session support to place them onto
one CD.
2. Configuration
2.1 Files
First the file /etc/cdbak.conf is read if it exists. Followed
by ~/.cdbak.conf and $CDBAK. The contents of these files
are merged with the later ones overriding the contents
of earlier ones.
2.2 Specifying backup profiles
The configuration file contains a number of backup profiles.
These consist of a set of directories to backup and various
other parameters that control the backup.
Each section in the file begins with the profile name in
square brackets. Following this are a number of parameters
that control the backup. For example:
[SYSTEM]
backup:
dir /boot
dir /etc
dir /root
dir /var
Here we have a profile named SYSTEM that specifies that
everything under /boot, /etc, /root and /var will be backed
up.
2.2.1 Backup directory list
The word backup is followed by a colon and then all following
lines beginning with spaces. The backup item takes a series
of dir commands; one per line for each directory that is
to be backed up.
2.2.2 Controlling the directory layout on the CD
By default, files are placed on the CD at the same path
as they exist on your disk. To change this you can place
a second directory name after the first which will become
the name that is used on the CD.
#
# In this example, with the following specification,
the file /etc/termcap
# would be written on the CD as /new/etc/termcap
#
backup:
dir /etc /new/etc
2.2.3 Excluding parts of the directory tree
Quite often there will be directories that you know should
not be backed up as they contain temporary files or files
that can be easily re-created.
You can exclude these with the except command in the configuration
file.
[HOME]
#
# In this example everything under /home/steve is
to be backed up
# apart from the directories build, tmp and kern.
# Also everything in the .netscape/cache and .netscape/xover-cache
# directories are excluded.
#
backup:
dir /home/steve, except build, except tmp,
except kern,
except .netscape/cache,
except .netscape/xover-cache
After dir is a comma and then the word except followed
by a directory to exclude. This directory is relative to
the one given by dir. For example dir /A , except B/C would
exclude /A/B/C from the backup. Lines ending in a comma
are continued on the next line.
2.3 The DEFAULT section
The default section is special and is not the name of a
backup profile. In the DEFAULT section you can place all
parameters that do not change from profile to profile.
If a parameter occurs in the DEFAULT section and in a profile,
then the value in the profile will be used.
output The file name that the backup is written
to. This file will be up to the size
of a CD (650MB) and so should be on a
partition that has plenty of space.
output: /temp/backup.raw
application_id This is the name that will be put onto
the CD header. You can use it to identify
the backup, and in this case it should
probably be overridden in each section.
rockridge Use Rock Ridge format. This should be
set to yes unless you have a good reason
not to.
rockridge: yes
rockridge_dist This passes the -r option to mkisofs
rather than -R. See the mkisofs documentation
for exact details of what it does. Basically
this option is more useful for distributing
software as all the ownership and file
mode information is removed. For you
own backups you would usually set this
to no.
device This is the device name that will be
passed to cdrecord. See the cdrecord
documentation for this.
device: 0,0
speed The CD writing speed.
speed: 2
cdbak-0.1.0/COPYING 100664 764 764 43105 6711716445 12376 0 ustar steve steve GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C) 19yy
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19yy name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
cdbak-0.1.0/INSTALL 100664 764 764 2200 6712040737 12336 0 ustar steve steve
Things you need first
---------------------
You need python-1.5 which you may already have, if not get it from
www.python.org or any of the Linux distributions. You also need the
GTK+ interface for python, which you may need to obtain first from
ftp://ftp.daa.com.au/pub/james/python/ it is part of the gnome-python
package. You do not need gnome for this package.
Installation of cdbak
---------------------
There is no need to build or install anything; issuing the command:
python cdbak.py
will run the application.
All you need to do is put the files somewhere, ensure that cdbak.py
is executable and make a symbolic link to it from, say, /usr/local/bin.
For example put all the files in /usr/lib/python1.5/site-packages/CDBAK
and make a link:
ln -s /usr/lib/python1.5/site-packages/CDBAK/cdbak.py /usr/local/bin/cdbak
Running 'make install' will work on many systems.
Configuration
-------------
Copy the file cdbak.conf to /etc/cdbak.conf or to ~/.cdbak.conf
in your home directory.
There are some examples in that file, but you will want to modify
it to match your own system. See the documentation directory for
more details.
cdbak-0.1.0/Makefile 100664 764 764 1271 6711600626 12752 0 ustar steve steve
PYFILES = cdbak.py cmds.py command.py config.py control.py gui.py
# Modify to alter location
INSTBIN = /usr/local/bin
all: compile
compile:
for i in *.py; \
do \
python -O -c "import `basename $$i .py`"; \
python -c "import `basename $$i .py`"; \
done
chmod a+x cdbak.py
install: compile
@if [ -d /usr/lib/python1.5 ]; then \
DEST=/usr/lib/python1.5/site-packages/CDBAK; \
elif [ -d /usr/local/lib/python1.5 ]; then \
DEST=/usr/local/lib/python1.5/site-packages/CDBAK; \
else echo "Can not find python installation, please read INSTALL file";\
exit 1;\
fi;\
if [ ! -d $$DEST ]; then mkdir $$DEST; fi ;\
cp *.py *.py[co] $$DEST; \
ln -s $$DEST/cdbak.py $(INSTBIN)/cdbak
cdbak-0.1.0/README 100664 764 764 2145 6711600626 12173 0 ustar steve steve
This is GUI interface for linux that is specifically designed for making
backups, or other regularly repeated CD writing operations. You set up
a series of directories that will fit on to one CD and the interface
allows you to select between them. This is a first release and so
has a fairly minimum set of features.
It uses mkisofs and cdrecord to do the actual work.
There are a number of general purpose CD burner interfaces,
which you may prefer for some purposes see for example
http://www.fokus.gmd.de/nthp/employees/schilling/cdb.html for
some links.
You need python-1.5 which you may already have, if not get it from
www.python.org or any of the Linux distributions. You also need the
GTK+ interface for python, which you may need to obtain first from
ftp://ftp.daa.com.au/pub/james/python/ it is part of the gnome-python
package. You do not need gnome for this package.
You can try it out without making or installing it anywhere
with the following command
python cdbak.py
See the install file for the simple install instructions
See the doc directory for other documentation.
steve@parabola.demon.co.uk
cdbak-0.1.0/cdbak.conf 100664 764 764 4763 6712045733 13241 0 ustar steve steve #
# This is an example .cdbak.conf file it should be modified for
# your own purposes and installed in /etc/cdbak.conf or ~/.cdbak.conf
#
# NOTE: The default section at the bottom should be read first. Most
# parameters are set in that section with explinations.
#
[TEST]
backup:
dir /tmp/test
[HOME]
backup:
dir /home/steve, except build tmp kern,
except .netscape/cache .netscape/xover-cache
dir /home/soffice,
except lib help gallery
[SYSTEM]
backup:
dir /boot
dir /etc
dir /root
dir /var
[SOURCE]
backup:
dir /usr/src,
except BUILD SOURCES redhat
#
# This is the default section. It should not be changed unless you
# are sure that you want it to apply to all profiles.
# Any of the parameters in here can be applied to any other profile
#
# NOTE: Parameters that are commented out are not implemented.
#
[DEFAULT]
#
# The file to which the filesystem is written before being
# burned onto the CD. It needs to be on a file system with
# plenty of space.
#
output: /mnt/c/backup.raw
#
# The files to backup. Usually directories are given.
#
# The following spec does the following:
# backup everything under /usr/local
# everything under /etc and place it on the cd as /cdetc
# everything under /usr/src, except for /usr/src/BUILD /usr/src/redhat etc.
#backup:
# dir /usr/local
# dir /etc /cdetc
# dir /usr/src,
# except BUILD redhat.
# except SOURCE
# If set to yes, includes temp files containing ~ or #
#allfiles: no
# Text string up to 128 characters to describe this CD
application_id: Backup
# If set, deeply nested directories are not relocated
#deep_directory_relocation: no
# Follow symbolic links
#follow_symlinks: no
# Joliet is useful for Windows machines
#use_joliet: no
# Exclude from being written eg. '*.o' core
#exclude_pattern:
# Publisher information. 128 character max
#publisher_id: Steve Ratcliffe
# Preparer information. 128 chars max
#preparer_id: Steve Ratcliffe
# Use Rock Ridge format; see also rockridge_dist.
rockridge: yes
# Use rockridge and change owner and modes to be more useful
# when distributed to someone else.
# Has no affect if rockridge is not set, for you're own backups
# you will probably want to set this to 'no' to preserve ownership
# information
rockridge_dist: no
# Exclude a file(s) based on complete path name eg /etc/motd
#exclude_path:
#########################
## Parameters for cdrecord
# The device in the form [scsibus,]target,lun
device: 0,0
# The writing speed.
speed: 2
cdbak-0.1.0/cdbak.py 100775 764 764 2162 6711330113 12722 0 ustar steve steve #!/usr/bin/python -O
#
# cdbak - cd record backup program
#
# Copyright (C) 1999 Steve Ratcliffe
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
import os, ConfigParser
import gtk
import gui
import control
import config
import command
class error(Exception):
pass
# The main routine
def main():
conf = config.get_config()
config_list = config.get_file_lists(conf)
# Set up the gui front end and the control callbacks
# and the links between them.
cb = control.Callbacks()
interface = gui.CdbakGui(config_list, cb)
cb.set_frontend(interface)
interface.init_screen()
cb.set_conf(conf)
gtk.mainloop()
command.killall()
if __name__ == '__main__':
import cdbak
try:
main()
except cdbak.error, msg:
print "CDBAK ERROR:", msg
cdbak-0.1.0/cmds.py 100664 764 764 5776 6711330113 12617 0 ustar steve steve #
# Interface to the mkisofs and cdrecord Linux commands.
#
# Copyright (C) 1999 Steve Ratcliffe
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
import string
import command
import cdbak
##
def mkisofs(conf, section, filelist):
"""
Take a list of options and a list of path names and run the mkisofs
command to create the file system.
"""
argv = []
argv.append(get_value(conf, section, 'mkisofs', 'mkisofs'))
# Set the output file
argv.append('-o')
argv.append(conf.get(section, 'output'))
if get_bool(conf, section, 'allfiles'):
argv.append('-a')
val = get_value(conf, section, 'application_id')
if val:
argv.append('-A')
argv.append(val)
val = get_bool(conf, section, 'rockridge')
val2 = get_bool(conf, section, 'rockridge_dist')
if val:
if val2:
argv.append('-r')
else:
argv.append('-R')
# Now follows strings of file system directories and the corresponding
# directories on the CD. The CD place comes first. The trailing
# slashes are significant and mean that it will be a directory
#
fileargv = []
exclude_argv = []
for (fs, cd, excludelist) in filelist:
# The default is the root directory on the CD
if cd == '/':
fileargv.append(fs)
else:
fileargv.append(cd + '=' + fs)
# Add -m options for each excluded path
for e in excludelist:
exclude_argv.append('-m')
exclude_argv.append(e)
argv = argv + exclude_argv + fileargv
c = command.Command(argv)
return c
# Build up a cdrecord command based on the specified options.
def cdrecord(conf, section):
argv = []
val = get_value(conf, section, 'cdrecord', 'cdrecord')
argv.append(val)
argv.append('-v')
#argv.append('-multi')
val = get_value(conf, section, 'device')
if val:
argv.append('dev=%s' % val)
else:
raise cdbak.error, "No 'device' parameter specified"
val = get_value(conf, section, 'speed', 1)
if val:
argv.append('speed=%s' % val)
val = get_value(conf, section, 'output')
if val is None:
raise cdbak.error, "No 'output' parameter specified"
if val == '/dev/null':
return command.Command(string.split(
"echo OK, Just testing! (output of /dev/null specified)"))
argv.append(val)
#print "cdrecord CMD:", argv
c = command.Command(argv)
return c
#### Helper utilities
##
def get_value(conf, section, name, d=None):
"""
Return the value of parameter name from conf. If not specified then
the default is returned.
If no default given, it is the name of the variable.
"""
try:
val = conf.get(section, name)
except:
val = d
return val
def get_bool(conf, section, name):
try: val = conf.get(section, name)
except: return 0
if string.lower(val[:1]) == 'y':
return 1
else:
return 0
cdbak-0.1.0/command.py 100664 764 764 10140 6711600743 13315 0 ustar steve steve #
# The mkisofs and cdrecord commands interface.
#
# Copyright (C) 1999 Steve Ratcliffe
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
"""
This file interfaces to the mkisofs and the cdrecord commands.
Build up the command strings.
Execute the commands.
Wait for command completion
Get command output
Extract percentage complete information.
Kill process on cancel
"""
from os import *
import posixfile
import string
import time
Procs = {}
# Run a command and make the output available in a non-blocking manner.
# This is much like popen3, although the output there is not specifically
# non-blocking
#
class Command:
def __init__(self, argv):
self.bufs = []
self.buf = ''
self.startTime = time.time()
rfd, wfd = pipe() # For stdout
# It appears that the only way to make a non blocking file
pf = posixfile.fileopen(fdopen(rfd))
pf.flags('n')
self.rfile = pf
pid = fork()
if pid == 0:
# Child
close(rfd)
dup2(wfd, 1)
dup2(wfd, 2)
# Make this a new process group as cd forks into two
# and so we need to kill a process group and not just
# the process we started.
setsid()
# Print out here so it will appear in the text window.
print "\n\nCommand:", string.join(argv)
try:
execvp(argv[0], argv)
except:
execvp('/bin/false', ['false'])
# Unfortunately this does not appear to work...
# which is why I have the /bin/false
_exit(1)
# In parent
close(wfd)
Procs[pid] = '' # Create an entry in the dictionary for it
self.pid = pid
self.status = -1
def readline(self):
stuff = ''
try:
stuff = self.rfile.read()
if stuff:
# Get rid of any CR and turn them into NL
stuff = string.replace(stuff, '\r', '\n')
if stuff[0] == '\b':
# Groan -- cdrecord uses backspaces to do the countdown
# deal with it by duplicating the line and appending
# the backspaced line.
r = 0
for c in stuff:
if c != '\b':
break
r = r+1
self.bufs.append('\n') # Force out previous line
self.bufs.append(self.buf[:-r] + stuff[r:])
else:
self.bufs.append(stuff)
except IOError, msg:
pass
self._joinbufs()
try:
r = string.index(self.buf, '\n')
except ValueError:
pass
else:
ret = self.buf[:r+1]
self.buf = self.buf[r+1:]
return ret
return ''
def _joinbufs(self):
if self.bufs:
for b in self.bufs:
self.buf = self.buf + b
self.bufs = []
# Check to see if the command has exited
def has_exited(self):
if self.status >= 0:
return 1 # Already finished
try:
pid, status = waitpid(self.pid, WNOHANG)
except error:
status = 1000
return 1 # Probably not even running
if pid == self.pid:
self.status = status
try: del Procs[self.pid]
except KeyError: pass
return 1
# Still running
return 0
# Kill the process group created above
def kill(self):
try: kill(-self.pid, 2)
except OSError, msg: print "DEBUG: could not zap", msg
time.sleep(0.2)
try: kill(-self.pid, 15)
except OSError: pass
try: del Procs[self.pid]
except KeyError, msg: print "DEBUG: could not delete pid", msg
# Wait for the command
def wait(self):
while self.status < 0:
try:
pid, status = waitpid(self.pid, 0)
except OSError:
break
if pid == self.pid:
self.status = status
def __del__(self):
#print "COMMAND DELETED", self.pid
pass
def killall():
for pid in Procs.keys():
try: kill(pid, 9)
except OSError: pass
global Procs
Procs = {}
# For testing only
if __name__ == '__main__':
# Test program
c = Command(['mkisofs', '-v', '-o', '/tmp/foo.fs', '/home/steve/bak'])
while 1:
b = c.readline()
if b:
print "OUT", b
elif c.has_exited():
while 1:
b = c.readline()
if b is None or b == '': break
print "OUT2", b
break
cdbak-0.1.0/config.py 100664 764 764 10040 6711600743 13143 0 ustar steve steve #
# Configuration file handling
#
# Copyright (C) 1999 Steve Ratcliffe
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
import os, stat, string, glob
import ConfigParser
import cdbak
# A default configuration
#
default_config = {
"allfiles": """no""",
"application_id": """Backup""",
"deep_directory_relocation": """no""",
"exclude_path": """""",
"exclude_pattern": """""",
"follow_symlinks": """no""",
"output": """/usr/tmp/backup.raw""", # yea no chance
"preparer_id": """Steve Ratcliffe """,
"publisher_id": """Steve Ratcliffe """,
"rockridge": """yes""",
"use_joliet": """no""",
}
# Get config information
def get_config():
"""Get configuration information
"""
conf = ConfigParser.ConfigParser(default_config)
conf_files = get_conf_files()
conf.read(conf_files)
return conf
def get_file_lists(conf):
"""
Return a list of the configured file list options
It is in the form:
('listname', [('path-on-disk', 'path-to-be-placed-on-CD'), ...]), ...
"""
conflist = []
for s in conf.sections():
listname = s
for v in conf.options(s):
if v == 'backup':
files = parse_backup_spec(conf.get(s, v))
break
conflist = conflist + [(listname, files)]
return conflist
def parse_backup_spec(spec):
list = []
lines1 = string.split(spec, '\n')
# Lines ending in a comma should be joined with the next line
lines = []
i = 0
while i < len(lines1):
line = string.strip(lines1[i])
# If the line ends in a comma then join the next one to it.
#
while line[-1:] == ',':
try:
line = line + lines1[i+1]
i = i+1
except IndexError:
break
# Add line in
lines.append(line)
i = i+1
for line in lines:
line = string.strip(line)
tok = string.split(line)
if len(tok) < 1:
continue # A blank line
if tok[0] == 'dir' or tok[0] == 'file':
item = parse_dir(tok)
elif tok[0] == 'file':
item = parse_file(tok)
else:
raise cdbak.error, "Bad command in configuration file: " + line
list = list + item
return list
def parse_dir(t):
l = []
# Join it back together, without first line
str = string.join(t[1:])
# Split by comma separated fields
fields = string.split(str, ',')
if len(fields) == 0:
raise cdbak.error, "Program error" # This can't happen
# The first field is either a single directory or a pair of directories.
dirs = fields[0]
dirspec = string.split(dirs)
base = add_slash(dirspec[0])
# If no alternate directory was given then we use the base name
if len(dirspec) == 1:
todir = base
else:
todir = add_slash(dirspec[1])
#
# Now deal with the rest of the fields
#
exceptlist = []
for f in fields[1:]:
tok = string.split(f)
if len(tok) == 0: continue
if tok[0] == 'except':
# These are files/directories to be excluded
for word in tok[1:]:
exceptlist.append(base + word + '/*')
else:
raise cdbak.error, "Incorrect sub-option in configuration file: "\
+tok[0]
l.append((base, todir, exceptlist))
return l
def parse_file(t):
return [(t[0], 'WARNING: Not implemented yet')]
def get_conf_files():
"""Get a list of places to try for configuration information.
"""
list = []
#
# This list must be ordered from least specific to most as later
# definitions will override earlier ones. The files also get merged.
#
list.append('/etc/cdbak.conf')
try:
f = os.environ['HOME'] + '/' + '.cdbak.conf'
list.append(f)
except KeyError: pass
try:
f = os.environ['CDBAK']
list.append(f)
except KeyError: pass
return list
# Add a slash to the end of the path name if not already there.
def add_slash(name):
if len(name) == 0:
return '/'
elif name[-1] != '/':
return name + '/'
else:
return name
cdbak-0.1.0/control.py 100664 764 764 14522 6711600743 13367 0 ustar steve steve #
# A control class for dealing with callbacks from the gui front end.
#
# Copyright (C) 1999 Steve Ratcliffe
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
import string
import time
import cmds
import gtk
import gui
"""
This is the main logic control for the program. It interfaces
between the gui interface and the backend commands.
All control of the interface is done from here.
"""
#
class Callbacks:
def __init__(self):
self.Command = None
self.Page = 'make'
self.completionProgress = []
self.okDialog = gui.OKdialog()
def set_frontend(self, w):
self.Interface = w
def set_cmd(self, cmds):
self.Command = cmds
self.percentComplete = 0
def set_conf(self, conf):
self.Config = conf
def onNextPrev(self, (name, num), inc):
"""
Called when the Next/Prev button is clicked.
Should do whatever operation is required and cause the relevant
page of the gui to be displayed.
"""
self.doPageChange(inc)
def onCancel(self, what):
""" Called when the cancel button is clicked
"""
if self.Command is not None:
self.Command.kill()
self.Command.wait()
self.okDialog.show_message("Command was canceled",
self.doPageChange, -1)
self.Command = None
def profileSelect(self, name, flist):
""" Called when a profile is selected by the user.
The selected profile name is passed in.
"""
if name[:2] == '--':
return
self.Profile = name
self.FileList = flist
self.Interface.allow_step()
# This command runs in the idle loop, and updates the status
# window with any output from the commands.
def monitor_cmd(self, prog=None):
if prog is None:
prog = self.currentProgress
if self.Command is None:
return 0
while 1:
line = self.Command.readline()
# If the line is null then we check to see if the command
# has finished
if line == '':
self.set_percent(prog) # Interpolate percentage progress!
if self.Command.status >= 0:
break # Already waited for it
elif self.Command.has_exited():
# This will set Status so we won't get here again
continue
else:
break
else:
if line[-1] != '\n':
line = line + '\n'
self.Interface.StatusText.insert_defaults(line)
# Look for progress indications
# xx.xx% done, estimate finish...
# 23 of 123MB ...
#
if string.find(line, 'done, estimate finish') >= 0:
f = string.atof(line[:string.index(line, '%')])
f = f/100
if f > 1:
f = 1.0
self.set_percent(prog, f)
elif string.find(line, 'MB written') > 0:
# Should be: 'Track 01: 9 of 123 MB written ...
toks = string.split(line)
f = string.atof(toks[2]) / string.atof(toks[4])
if f > 1:
f = 1.0
self.set_percent(prog, f)
if self.Command.status >= 0:
if self.Command.status == 0:
# Command successful..
self.doPageChange(1)
else:
self.okDialog.show_message("Command failed",
self.doPageChange, -1)
self.Command = None
self.completionProgress = []
return 0 # We sould not be called again, command is finished
return 1
#
# Set the percentage progress bar. We use indications from the
# output about how the progress is going. Inbetween we interpolate
# to get a smooth progress indication.
#
def set_percent(self, prog, percent = None):
curtime = time.time() - self.Command.startTime
if percent is None:
# Interpolate given the current time and previous
# progress.
try:
l = len(self.completionProgress)
if l > 1:
(t1, p1) = self.completionProgress[l-1]
(t2, p2) = self.completionProgress[0]
rate = (p1-p2)/(t1-t2)
elif l == 1:
(t1, p1) = self.completionProgress[0]
rate = p1/t1
else:
raise ValueError
nt = curtime - t1 # Time since last real information
np = rate * nt # Estimated extra progress
p = p1 + np # Estimated total progress
#print "t1=%f, cur=%f, rate=%f" % (t1, curtime, rate)
#print "nt=%f, np=%f, p=%f" % (nt, np, p)
if p > 1:
p = 1.0
prog.set_percentage(p)
except ValueError:
pass # Thats OK just no info yet.
else:
if percent > 1:
percent = 1.0
self.completionProgress.append((curtime, percent))
prog.set_percentage(percent)
# Do the transition from one state to another.
def doPageChange(self, inc):
for li in States:
if li[CURRENT] == self.Page:
if inc > 0:
npage = li[NEXT_PAGE]
li[NEXT_ACTION](self, npage)
else:
npage = li[PREV_PAGE]
li[PREV_ACTION](self, npage)
break
else:
print "ERROR: on unknown page"
raise SystemExit
self.Page = npage
def domake(c, page):
proc = cmds.mkisofs(c.Config, c.Profile, c.FileList)
c.set_cmd(proc)
cdbak_add_timeout(c, 100, c.monitor_cmd, c.Interface.progressPrepare)
steppage(c, page, allow=0)
def finmake(c, page):
steppage(c, page)
def dowrite(c, page):
proc = cmds.cdrecord(c.Config, c.Profile)
c.set_cmd(proc)
cdbak_add_timeout(c, 100, c.monitor_cmd, c.Interface.progressWrite)
steppage(c, page, allow=0)
# In gtk the timeout_add function takes a third argument. pygtk does
# not. It is possible that pygtk will be fixed in the future though.
# This routine works around this and should work in both cases.
def cdbak_add_timeout(c, interval, func, arg):
try:
gtk.timeout_add(interval, func, arg)
except TypeError:
gtk.timeout_add(interval, func)
c.currentProgress = arg
def finwrite(c, page):
steppage(c, page)
def steppage(c, name, allow=1):
c.Interface.set_page(name)
c.Interface.allow_step(allow)
# State transition table.
[
CURRENT, # Current page
NEXT_ACTION, # Action when Next is clicked
NEXT_PAGE, # The next page to go to
PREV_ACTION, # Action when Prev is clicked
PREV_PAGE, # The page to go to on a Prev
] = range(5)
States = [
['make',
domake, 'make_progress',
steppage, 'make',
],
['make_progress',
finmake, 'write',
steppage, 'make',
],
['write',
dowrite, 'write_progress',
steppage, 'make',
],
['write_progress',
finwrite, 'finished',
steppage, 'make',
],
['finished',
steppage, 'make',
steppage, 'make',
],
]
cdbak-0.1.0/gui.py 100775 764 764 25762 6711600743 12506 0 ustar steve steve #!/usr/bin/python -O
#
# the gui for cdbak
#
# Copyright (C) 1999 Steve Ratcliffe
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
from gtk import *
import command
# Contants to show what has been done
PROFILE_SELECTED = 1
mkfs_help_text= """
Select the backup
profile from the
drop down list.
"""
write_help_text="""
If all seemed to go well
with preparing the filesystem,
ensure that there is a CD in
the drive.
"""
finish_help_text ="""
CD Backup is complete
"""
# String that shows that no choice was made
no_selection = '--select--'
# Quit the whole display
def quit(win, event=None):
command.killall()
mainquit()
return 0
# Add widget to container and show it
def addbox(box, w, expand=TRUE, fill=TRUE, padding=0):
box.pack_start(w, expand, fill, padding)
w.show()
class CdbakGui:
def __init__(self, FileList, cback):
self.FileList = FileList
self.EventCallback = cback
self.Page = 0
self.NPages = 0
self.PageInfo = []
self.AllowChange = 0
self.Labels = {}
self.NextFinishText = ['']
# Draw everything on the main screen
#
def init_screen(self):
win = GtkWindow(WINDOW_TOPLEVEL)
win.set_default_size(screen_width()*60/100, screen_height()*80/100)
win.set_title("CD backup")
#
# The application is made from a series of panels placed
# on top of each other.
#
mainvbox = GtkVBox(0)
win.add(mainvbox)
mainvbox.show()
win.connect("delete_event", quit)
w = self.topbox()
w.set_usize(0, 60)
addbox(mainvbox, w, expand=0)
w = self.userinput()
w.set_usize(100, 200)
addbox(mainvbox, w, expand=0)
w = self.buttonrow()
addbox(mainvbox, w, expand=0)
w = self.status()
addbox(mainvbox, w, fill=1)
self.update_pages()
win.show()
# Make the dialogue associated with the main window
# and positioned conveniently for the mouse.
#
self.EventCallback.okDialog.set_position(WIN_POS_MOUSE)
self.EventCallback.okDialog.set_transient_for(win)
# The top of the Screen, this is basically a title and
# welcome panel
#
def topbox(self):
frame = GtkFrame("CD backup")
welcome = GtkLabel("Welcome to CDBAK")
frame.add(welcome)
welcome.show()
return frame
#
# This is the main user interaction window. There is a sequence of
# screens that you can step through.
#
def userinput(self):
nb = GtkNotebook()
nb.set_show_tabs(0)
# Save the book
self.Userbook = nb
# Add in the pages
w = self.mkfs_page()
self.addpage(w, 'make')
w = self.progress_page('make')
self.addpage(w, 'make_progress')
w = self.write_page()
self.addpage(w, 'write')
w = self.progress_page('write')
self.addpage(w, 'write_progress')
w = self.finish_page()
self.addpage(w, 'finished')
return nb
def buttonrow(self):
bbox = GtkHButtonBox()
bbox.set_border_width(6)
bbox.set_spacing(5)
bprev = GtkButton("<< Prev")
addbox(bbox, bprev)
bnext = GtkButton()
addbox(bbox, bnext)
bquit = GtkButton("Quit")
addbox(bbox, bquit)
# Save the ones that we need to access elsewhere
self.Next = bnext
self.Prev = bprev
bquit.connect("clicked", quit, 'hello')
bnext.connect("clicked", self.onNextPrev, 1)
bprev.connect("clicked", self.onNextPrev, -1)
# The Next button can also be labeled 'Finish' so we need
# to save the Label so we can change the text on it
nlab = GtkLabel("Next >>")
self.Labels['Next'] = nlab
self.Next.add(nlab) # Add to the button
nlab.show()
hbox = GtkHBox()
hbox.pack_start(bbox, expand=0)
bbox.show()
return hbox
#
# The next routines construct the controls that appear in the
# middle of the application. The next and prev buttons
# step among them.
#
# Select the backup type, this consists of a help label, a
# combo box with the possible options and the list of selected files.
#
def mkfs_page(self):
frame = GtkFrame("Make filesystem")
tab = GtkTable(2, 2, homogeneous=0)
fslabel = GtkLabel(mkfs_help_text % {'action':self.NextFinishText[0]})
tab.attach(fslabel, 0, 1, 0, 1, xoptions=0, xpadding=5)
fslabel.show()
cs, filetab = self._combo_select()
tab.attach(cs, 0, 1, 1, 2, xoptions=0, xpadding=5)
tab.attach(filetab, 1, 2, 0, 2, xoptions=EXPAND|FILL)
cs.show()
filetab.show()
frame.add(tab)
tab.show()
return frame
# Shows the progress of the current action.
#
def progress_page(self, type):
frame = GtkFrame()
box = GtkVBox()
frame.add(box)
box.show()
lab = GtkLabel("Please wait while the backup is prepared")
addbox(box, lab, padding=4)
prog = GtkProgressBar()
addbox(box, prog, expand=0)
if type == 'make':
description = "Preparing backup"
self.progressPrepare = prog
else:
description = "Writing CD"
self.progressWrite = prog
frame.set_label(description)
prog.set_show_text(1)
prog.set_format_string(description)
# Create a big Cancel button
bbox = GtkHButtonBox()
bcancel = GtkButton("Cancel")
bcancel.set_border_width(10)
bcancel.connect("clicked", self.onCancel, type)
addbox(bbox, bcancel)
addbox(box, bbox, fill=0)
prog.update(0.0)
return frame
# The screen to set up writing the CD
#
def write_page(self):
lab = GtkLabel(write_help_text)
return lab
# The page shown when all is finished
#
def finish_page(self):
lab = GtkLabel(finish_help_text)
return lab
#
# Status box at the bottom that contains output lines
# from commands that are run.
#
def status(self):
frame = GtkFrame("Command output")
text = GtkText()
sw = GtkScrolledWindow()
sw.set_policy(POLICY_NEVER, POLICY_ALWAYS)
frame.add(sw)
sw.show()
sw.add(text)
text.show()
self.StatusText = text
return frame
# Return a combo box of the filesystem choices an a list box showing
# the currently selected profile.
#
def _combo_select(self):
combo = GtkCombo()
strs = [no_selection]
for (name, l) in self.FileList:
strs = strs + [name]
combo.set_popdown_strings(strs)
combo.entry.set_editable(0) # Disable editing
"""
tab = GtkTable(3, 2)
head1 = GtkLabel("From")
head2 = GtkLabel("On CD")
tab.attach(head1, 0, 1, 0, 1, yoptions=0, ypadding=4)
tab.attach(head2, 2, 3, 0, 1, yoptions=0, ypadding=4)
head1.show()
head2.show()
#
frombox = GtkList()
tobox = GtkList()
frombox.show()
tobox.show()
tab.attach(frombox, 0, 1, 1, 2)
tab.attach(tobox, 2, 3, 1, 2)
sep = GtkVSeparator()
tab.attach(sep, 1, 2, 0, 2, xoptions=0)
sep.show()
"""
cl = GtkCList(2, ['Path', 'On CD'])
cl.column_titles_passive()
cl.set_usize(100, 100)
cl.set_column_min_width(0, 200)
cl.set_column_min_width(1, 200)
combo.entry.connect("changed", self.set_file_list, cl)
# Put the lists in a frame as it looks better
#frame = GtkFrame()
#frame.add(cl)
#cl.show()
sw = GtkScrolledWindow()
sw.set_policy(POLICY_AUTOMATIC, POLICY_AUTOMATIC)
sw.add(cl)
cl.show()
return combo, sw
# This fills in the list of directories that are selected for
# backing up.
def set_file_list(self, entry, cl):
sel = entry.get_text()
cl.clear()
if sel != no_selection:
for (name, selected_file_list) in self.FileList:
if sel == name:
sellist = selected_file_list
for (f, t, exceptlist) in sellist:
cl.append((f, t))
for e in exceptlist:
cl.append((' '+e, ' '))
break
self.EventCallback.profileSelect(sel, sellist)
### General routines.
# Update everything to do with the pages interface
#
def update_pages(self):
if self.AllowChange == 0:
self.Next.set_sensitive(0)
self.Prev.set_sensitive(0)
else:
if self.Page == 0:
self.Prev.set_sensitive(0)
else:
self.Prev.set_sensitive(1)
if self.Page >= self.NPages-1:
self.Next.set_sensitive(0)
else:
self.Next.set_sensitive(1)
self.NextFinishText[0] = "Next >>"
self.Labels['Next'].set_text(self.NextFinishText[0])
self.Userbook.set_page(self.Page)
### Callback routines that work within the gui
def onNextPrev(self, button, inc):
# Tell Calling application, gets the page name that we are on
self.AllowChange = 0 # Wait for app to turn them back on
self.EventCallback.onNextPrev(self.PageInfo[self.Page], inc)
self.update_pages()
def onCancel(self, button, data):
self.EventCallback.onCancel(type)
self.AllowChange = 1
def addpage(self, p, name):
self.Userbook.add(p)
self.PageInfo = self.PageInfo + [(name, self.NPages)]
self.NPages = self.NPages + 1
p.show()
# Allow changes via the prev and next buttons
def allow_step(self, yes=1):
if yes:
self.AllowChange = 1
else:
self.AllowChange = 0
self.update_pages()
def set_page(self, page):
""" Set the page of the user interface """
if type(page) == type(0):
self.Page = page
else:
for (name, num) in self.PageInfo:
if name == page:
self.Page = num
if self.Page < 0: self.Page = 0
if self.Page >= self.NPages: self.Page = self.NPages-1
self.update_pages()
class OKdialog(GtkDialog):
def __init__(self):
GtkDialog.__init__(self)
self.connect("delete_event", self.take_down)
self.set_usize(400, 200)
lab = GtkLabel("Error occured") # This should always be re-set
lab2 = GtkLabel("Click OK to continue")
# Add the labels
self.vbox.add(lab)
self.vbox.add(lab2)
lab.show()
lab2.show()
bbox = GtkHButtonBox()
ok = GtkButton("OK")
ok.set_flags(CAN_DEFAULT)
ok.connect("clicked", self.onClick)
bbox.add(ok)
ok.show()
# Add to the action area part of the dialog
self.action_area.add(bbox)
bbox.show()
ok.grab_default()
self.OKbutton = ok
self.messageLabel = lab
# Pop up the dialog and show the message.
def show_message(self, msg, func=None, arg=None):
self._set_action(func, arg)
self.messageLabel.set_text(msg)
self.show()
grab_add(self)
# Set the action to take when the OK button is clicked
def _set_action(self, func, arg):
self.okFunc = func
self.okFuncArg = arg
def onClick(self, w):
grab_remove(self)
self.hide()
if self.okFunc:
self.okFunc(self.okFuncArg)
def take_down(self, w, foo):
self.destroy()
########### Test stuff
# Test list
tList = [
('hello', [('/var', 'var'), ('/home/steve', 'steve')]),
('world', [('/var', 'var'), ('/home/steve', 'steve'), ('/usr/src', 'src')]),
('another', [('/usr/local', 'local'), ('/var', 'var'), ('/home/steve', 'steve'), ('/usr/src', 'src')]),
('one', [('/home/soffice', 'soffice'), ('/usr/local', 'local'), ('/var', 'var'), ('/home/steve', 'steve'), ('/usr/src', 'src')]),
]
if __name__ == '__main__':
# Just for testing
class cback:
def onNext(self, (name, obj)):
self.FrontEnd.allow_step()
def onCancel(self, what):
self.FrontEnd.allow_step()
def profileSelect(self, name):
if name[:2] != '--':
self.FrontEnd.allow_step()
def set_frontend(self, w):
self.FrontEnd = w
cb = cback()
w = CdbakGui(tList, cb)
cb.set_frontend(w)
w.init_screen()
mainloop()