Installing a Custom Site from Launchpad

From IHRIS Wiki
Revision as of 11:28, 12 November 2013 by Sturlington (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

In this tutorial, we will install a custom iHRIS Manage 4.0 site hosted on Launchpad. We will bazaar to download the code as well as discuss the basics on how to modify the code on Launchpad. We are assuming that you are using an Ubuntu Linux machine.

Our first goal is to install the iHRIS Suite 4.0. Then we will download the CSSC's iHRIS Manage Customizations. Next we will create the database and finally we will install the site in our web-server.

Launchpad First Steps

First you should create an account on Launchpad if you not have already done so. We will refer to this account as LAUNCHPAD_USER.

Since we will want to contribute to the code, we will need to create a ssh public key on your Ubuntu machine to add to Launchpad: 

sudo apt-get install openssh-client
ssh-keygen -t rsa

When prompted, press Enter to accept the default file name for your key. Next, enter then confirm a password to protect your SSH key.

Your key pair is now stored in ~/.ssh/id_rsa.pub (public key) and ~/.ssh/id_rsa (private key). Now you need to upload the public portion of your SSH key to Launchpad. To do this, open in your web browser: 

https://www.launchpad.net/~LAUNCHPAD_USER

You will see a place that says SSH Keys with an exclamation point (!) in a yellow circle next to it. Click on the (!) scroll down until you see Add an SSH Key and a text box. We will paste our public key into this text box. To do so type in a terminal: 

gedit ~/.ssh/id_rsa.pub

you can now copy the contents of gedit (the public key) into the text box in the web browser. Now simply click on the button Import Public Key

For every computer/account that you use you will need to repeat these steps to create and import a public key.

Bazaar First Steps

First we need to make sure the Bazaaar (bzr) version control software is installed: 

 sudo apt-get install bzr bzrtools

You may wish to read the five minute tutorial at this point. You should also let bzr know how you are: 

 bzr whoami "Your Name <your@email.add.ress>"


Join the iHRIS Team

Launchpad uses "teams" to control who can modify code it stores under bazaar.

If you wish to make modifications to the CSSC Customizations, you should join the ihris+cssc team.

If you are working on a joint project, but not the CSSC's customizations, you should create a team in Launchpad and add yourself to it as well as the team intrahealth+informatics. For example, you could create the team ihris+tanzania.


Downloading iHRIS

We will now download the iHRIS Suite from Launchpad using bzr (as opposed to the release tar.bz2 files) to get practice using bazaar.

Below, I will assume that there is only one user using the system, or at least only one user that should be modifying files in iHRIS. This is probably not the "recommended" way of doing things though.

Changing Permissions

We want to make sure we can easily modify files under /var/lib/iHRIS without having to use sudo all the time. 

sudo mkdir -p /var/lib/iHRIS
sudo chown -R `whoami`:`whoami`  /var/lib/iHRIS


Release Code

Now we want to get the iHRIS Suite 4.0 release code from launchpad. 

sudo mkdir -p /var/lib/iHRIS/lib/4.0
sudo chown -R  `whoami`:`whoami` /var/lib/iHRIS/lib/4.0
cd /var/lib/iHRIS/lib/4.0
bzr branch lp:i2ce/4.0 I2CE
bzr branch lp:ihris-common/4.0 ihris-common
bzr branch lp:ihris-manage/4.0 ihris-manage
bzr branch lp:textlayout/4.0 textlayout

These branches will always contain the latest release code.

Development Code

If you wish to work with the development code instead, you should do this: 

sudo mkdir -p /var/lib/iHRIS/lib/4.0-dev
sudo chown -R `whoami`:`whoami` /var/lib/iHRIS/lib/4.0-dev
cd /var/lib/iHRIS/lib/4.0-dev
bzr branch lp:i2ce I2CE
bzr branch lp:ihris-common ihris-common
bzr branch lp:ihris-manage ihris-manage
bzr branch lp:textlayout textlayout

These branches will always contain the main development code, which may or may be working at a particular time.

Downloading CSSC's Customizations

Create a directory for Sites

First we will create a directory that will hold all the sites we have on our system. 

sudo mkdir -p /var/lib/iHRIS/sites/
sudo chown -R `whoami`:`whoami` /var/lib/iHRIS/sites

We have two choices on how to download the CSSC Customizations. One possibility to download it to install it, but do not want to make any code modifications. The other possibility is to download the code and have it setup to modify the customizations.

Download CSSC Customizations for no Modifications

We can download the CSSC customizations to our site directory by doing: 

cd /var/lib/iHRIS/sites
bzr branch lp:~ihris+cssc/ihris-manage/4.0-central cssc-central-4.0

You can still make modifications to the code, but they do not automatically get put back to launchpad once you commit.

Download CSSC Customizations for Modification

We can download the CSSC customizations to our site directory by doing: 

cd /var/lib/iHRIS/sites
bzr checkout lp:~ihris+cssc/ihris-manage/4.0-central cssc-central-4.0

To see why we are doing a checkout instead of a branch, read this. To make sure everything is working OK, you should make sure the following succeeds: 

cd /var/lib/iHRIS/sites/cssc-central-4.0
bzr commit -m "test commit"  --unchanged

Creating the Database

We will create a database called `cssc_central_4_0` as follows: 

mysql -u root -p 
mysql> CREATE DATABASE `cssc_central_4_0`; 
mysql> GRANT ALL PRIVILEGES ON `cssc_central_4_0`.* TO cssc@localhost identified by 'PASSWORD';

you should change PASSWORD to be the password you want.

Installing on the Web Server

Let us suppose we want to access the site at the URL: 

http://localhost/iHRIS/cssc-central

Linking the Site

First we will need to link to our customized site under '/var/www' as follows: 

sudo mkdir -p /var/www/iHRIS
sudo ln -s /var/lib/iHRIS/sites/cssc-central-4.0/pages /var/www/iHRIS/cssc-central

Setting the Database

We will need to specify the database and database user/password we are using. To do so: 

mkdir -p /var/lib/iHRIS/sites/cssc-central-4.0/pages/local
cp /var/lib/iHRIS/sites/cssc-central-4.0/pages/config.values.php /var/lib/iHRIS/sites/cssc-central-4.0/pages/local/config.values.php
gedit /var/lib/iHRIS/sites/cssc-central-4.0/pages/local/config.values.php

Look for the the following variables and set their values:

Variable Name Value
$i2ce_site_i2ce_path /var/lib/iHRIS/lib/4.0/I2CE
$i2ce_site_database cssc_central_4_0
$i2ce_site_database_user cssc
$i2ce_site_database_password PASSWORD (the password you set above)

Finishing Up

Just browse to the site at the URL: 

http://localhost/iHRIS/cssc-central

to begin the iHRIS installation process.

Modifying the Code

When you make changes to the code, you should do so in small steps with a message about what you have done. This will help other developer's understand what you have done and to help track down bugs. This process is called commiting. 

bzr help commit

Ignored Files

Anything in a directory named local is ignored. 

bzr help ignore
cd /var/lib/iHRIS/sites/cssc-central-4.0
bzr ignore

This is why in the above we copied config.values.php to local/config.values.php and set the database user name and password here. This way, if we are modifying the CSSC customizations we don't need to worry about the user name and password being uploaded to launchpad.


Updating files

If you are working with many people on a site customization, you can get the changes that they have made using the 'bzr update' command. For example: 

cd /var/lib/iHRIS/sites/cssc-central-4.0
bzr update

Changed Files

To see which files have changed since the last time someone commited: 

cd /var/lib/iHRIS/sites/cssc-central-4.0
bzr status

Committing Code

For instructions see: 

bzr help commit.


Command Line Editors

You may find that you will need to be able to edit a file from the command line, for example if you ssh into an iHRIS Appliance. There are several command line editors available that you can use to edit files and you should be familiar with at least one of them.

  • emacs: powerful but not userfriendly (Carl's choice)
  • vim: powerful but not userfriendly (Luke's choice)
  • nano: Nano is by the far the easiest one to use, but is not very powerful and you can only work with one file at a time:

Nano

  • to open a file to edit, type nano the_file_name.php on the command line
  • to determine the line number you hit [CTRL]-C
  • Goto a line number [CTRL]-_
  • save files with [CTRL]-O
  • search for text with [CTRL]-W
  • to cute (delete) a line [CTRL]-K
  • to paste the line(s) you just cut [CTRL]-U
  • if you decide to do a lot of editing in nano, you may want to add syntax highlighting. you can so as follows:
nano ~/.nanorc

and save the following: <source lang='text'>

    1. Sample initialization file for GNU nano.
    3. Please note that you must have configured nano with --enable-nanorc
    4. for this file to be read! Also note that this file should not be in
    5. DOS or Mac format, and that characters specially interpreted by the
    6. shell should not be escaped here.
    8. To make sure a value is disabled, use "unset <option>".
    10. For the options that take parameters, the default value is given.
    11. Other options are unset by default.
    13. Quotes inside string parameters don't have to be escaped with
    14. backslashes. The last double quote in the string will be treated as
    15. its end. For example, for the "brackets" option, ""')>]}" will match
    16. ", ', ), >, ], and }.
    1. Use auto-indentation.

set autoindent

    1. Backup files to filename~.

set backup

    1. The directory to put unique backup files in.
  2. set backupdir ""
    1. Do backwards searches by default.
  2. set backwards
    1. Use bold text instead of reverse video text.

set boldtext

    1. The characters treated as closing brackets when justifying
    2. paragraphs. They cannot contain blank characters. Only closing
    3. punctuation, optionally followed by closing brackets, can end
    4. sentences.

set brackets ""')>]}"

    1. Do case sensitive searches by default.
  2. set casesensitive
    1. Constantly display the cursor position in the statusbar. Note that
    2. this overrides "quickblank".

set const

    1. Use cut to end of line by default.
  2. set cut
    1. Set the line length for wrapping text and justifying paragraphs.
    2. If fill is 0 or less, the line length will be the screen width less
    3. this number.
  2. set fill -8
    1. Enable ~/.nano_history for saving and reading search/replace strings.

set historylog

    1. The opening and closing brackets that can be found by bracket
    2. searches. They cannot contain blank characters. The former set must
    3. come before the latter set, and both must be in the same order.

set matchbrackets "(<[{)>]}"

    1. Use the blank line below the titlebar as extra editing space.
  2. set morespace
    1. Enable mouse support, if available for your system. When enabled,
    2. mouse clicks can be used to place the cursor, set the mark (with a
    3. double click), and execute shortcuts. The mouse will work in the X
    4. Window System, and on the console when gpm is running.

set mouse

    1. Allow multiple file buffers (inserting a file will put it into a
    2. separate buffer). You must have configured with --enable-multibuffer
    3. for this to work.
  2. set multibuffer
    1. Don't convert files from DOS/Mac format.
  2. set noconvert
    1. Don't follow symlinks when writing files.
  2. set nofollow
    1. Don't display the helpful shortcut lists at the bottom of the screen.
  2. set nohelp
    1. Don't add newlines to the ends of files.

set nonewlines

    1. Don't wrap text at all.

set nowrap

    1. Set operating directory. nano will not read or write files outside
    2. this directory and its subdirectories. Also, the current directory
    3. is changed to here, so any files are inserted from this dir. A blank
    4. string means the operating directory feature is turned off.
  2. set operatingdir ""
    1. Preserve the XON and XOFF keys (^Q and ^S).
  2. set preserve
    1. The characters treated as closing punctuation when justifying
    2. paragraphs. They cannot contain blank characters. Only closing
    3. punctuation, optionally followed by closing brackets, can end
    4. sentences.
  2. set punct "!.?"
    1. Do quick statusbar blanking. Statusbar messages will disappear after
    2. 1 keystroke instead of 26. Note that "const" overrides this.
  2. set quickblank
    1. The email-quote string, used to justify email-quoted paragraphs.
    2. This is an extended regular expression if your system supports them,
    3. otherwise a literal string. Default:
  2. set quotestr "^([ ]*[#:>\|}])+"
    1. if you have extended regular expression support, otherwise:
  3. set quotestr "> "
    1. Fix Backspace/Delete confusion problem.
  2. set rebinddelete
    1. Fix numeric keypad key confusion problem.
  2. set rebindkeypad
    1. Do extended regular expression searches by default.
  2. set regexp
    1. Make the Home key smarter. When Home is pressed anywhere but at the
    2. very beginning of non-whitespace characters on a line, the cursor
    3. will jump to that beginning (either forwards or backwards). If the
    4. cursor is already at that position, it will jump to the true
    5. beginning of the line.
  2. set smarthome
    1. Use smooth scrolling as the default.
  2. set smooth
    1. Use this spelling checker instead of the internal one. This option
    2. does not properly have a default value.

set speller "aspell -x -c"

    1. Allow nano to be suspended.

set suspend

    1. Use this tab size instead of the default; it must be greater than 0.

set tabsize 4

    1. Convert typed tabs to spaces.

set tabstospaces

    1. Save automatically on exit, don't prompt.
  2. set tempfile
    1. Disallow file modification; why would you want this in an rcfile? ;)
  2. set view
    1. The two single-column characters used to display the first characters
    2. of tabs and spaces. 187 in ISO 8859-1 (0000BB in Unicode) and 183 in
    3. ISO-8859-1 (0000B7 in Unicode) seem to be good values for these.

set whitespace ". "

    1. Detect word boundaries more accurately by treating punctuation
    2. characters as part of a word.
  2. set wordbounds
    1. Here is an example for PHP

syntax "php" "\.php[2345s~]?$"

    1. php markings

color brightgreen "(<\?(php)?|\?>)"

    1. functions

color white "\<[a-z_]*\("

    1. types

color green "\<(var|float|global|double|bool|char|int|enum|const)\>"

    1. structure

color brightyellow "\<(class|new|private|public|function|for|foreach|if|while|do|else|elseif|case|default|switch)\>"

    1. control flow

color magenta "\<(goto|continue|break|return)\>"

    1. strings

color brightyellow "<[^= ]*>" ""(\.|[^"])*""

    1. comments

color brightblue "//.*" color brightblue start="/\*" end="\*/"

  1. color blue start="<" end=">"
  2. color red "&[^;space:]*;"
    1. Trailing whitespace

color ,green "space:+$"

include "/usr/share/nano/html.nanorc" 

##############################################################################
  2. Syntax highlighting for XML files
  4. Author: Josef 'Jupp' Schugt, jupp(a)rubyforge.org
  5. License: GPL 2 or later
  7. Version: 2004-02-25

syntax "ml" ".*\.([jrs]?html?|xml|sgml?|lhtml|opml|kdevelop|vcproj|glade|xsd|plist|gcs|dtd|dcl)$" "catalog$" "docbook$" color white "^.+$" color green start="<" end=">" color cyan "<[^> ]+" color cyan ">" color yellow start="<!DOCTYPE" end="[/]?>" color yellow start="" color red "&[^;]*;"

      1. all *js files ( e.g. Firefox user.js, prefs.js )


    1. New updated taken from http://wiki.linuxhelp.net/index.php/Nano_Syntax_Highlighting

syntax "JavaScript" "\.(js)$"

    1. Default

color white "^.+$"

    1. Decimal, cotal and hexadecimal numbers

color yellow "\<[-+]?([1-9][0-9]*|0[0-7]*|0x[0-9a-fA-F]+)([uU][lL]?|[lL][uU]?)?\>"

    1. Floating point number with at least one digit before decimal point

color yellow "\<[-+]?([0-9]+\.[0-9]*|[0-9]*\.[0-9]+)([EePp][+-]?[0-9]+)?[fFlL]?" color yellow "\<[-+]?([0-9]+[EePp][+-]?[0-9]+)[fFlL]?"

    1. Keywords

color green "\<(break|case|catch|continue|default|delete|do|else|finally)\>" color green "\<(for|function|if|in|instanceof|new|null|return|switch)\>" color green "\<(switch|this|throw|try|typeof|undefined|var|void|while|with)\>"

    1. Type specifiers

color red "\<(Array|Boolean|Date|Enumerator|Error|Function|Math)\>" color red "\<(Number|Object|RegExp|String)\>" color red "\<(true|false)\>"

    1. String

color brightyellow "L?\"(\\"|[^"])*\"" color brightyellow "L?'(\'|[^'])*'"

    1. Escapes

color red "\\[0-7][0-7]?[0-7]?|\\x[0-9a-fA-F]+|\\[bfnrt'"\?\\]"

    1. Comments

color magenta start="/\*" end="\*/" color magenta "//.*$" </source>

GUI Editors

We don't use these so I don't have any recommendations. You may want to look here for some recommendations.

  • gedit Not geared to programming. Installed by default on ubuntu desktop.
  • scite (sudo apt-get install scite)

Here are some IDEs

  • geany A small GUI editor geared to programming (sudo apt-get install geany)
  • bluefish (sudo apt-get install bluefish)
  • eclipse
Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Installing_a_Custom_Site_from_Launchpad&oldid=53047"