MongoDB Tutorial 2: Alternative control

From The Uniform Server Wiki
Revision as of 01:19, 24 November 2010 by Upazixorys (talk | contribs)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Under Construction! Please Visit Reserve Page. Page Will Be Available Shortly

 

MongoDB Plugin
UniServer 6-Carbo.

MongoDB

Introduction

Alternative control is a spin-off from testing the main application. These batch/scripts are worth keeping because users may prefer them.

Requirements

Scripts for alternative control are contained in folder z_mongo\UniServer\usr\local\mongo\alt_control\alt_control these scripts reflect functionality of our main program.

We require scripts that perform the following tasks:

  • Start MongoDB
  • Stop MongoDB
  • Run Mongo client
  • Open a command prompt

Four batch files and corresponding PHP scripts are required. These PHP scripts obtain their resources (paths function) from a shared include file located in folder z_mongo\UniServer\unicon\tray_menu_2.

Top

Main include file

During the introduction tutorial we created a file mongo_db_inc.php containing functions required for various application. A sub-set from this file is required for this application.

In folder z_mongo\UniServer\unicon\tray_menu_2.

create a new file named mongo_db_inc.php from file  z_mongo\temp\z_temp\mongo_db_inc.php copy the following lines.

<pre> $path_array = explode("\\usr",getcwd()); // Split at folder usr $mongo_base = $path_array[0]; // find drive letter and any sub-folders $mongo_base_f = preg_replace('/\\\/','/', $mongo_base); // Replace \ with /

//=== FOLDERS === define("MONGO_BIN", "$mongo_base_f/usr/local/mongo_tutorial/bin"); // Binaries for MongoDB

//=== FILES === define("CONFIG_NO_AUTH_F", "$mongo_base_f/usr/local/mongo_tutorial/bin/config_no_auth.ini"); define("CONFIG_AUTH_F", "$mongo_base_f/usr/local/mongo_tutorial/bin/config_auth.ini"); define("NAME_PWD_F", "$mongo_base_f/usr/local/mongo_tutorial/bin/mongo_name_password"); define("UNISERV_EXE", "$mongo_base_f/usr/local/mongo_tutorial/bin/uniserv.exe"); // Utility define("UNISERV_EXE_B", $mongo_base.'\usr\local\mongo_tutorial\bin\uniserv.exe'); // Utility define("MON_PSKILL_EXE", "$mongo_base_f/usr/local/mongo_tutorial/bin/pskill.exe"); // Utility define("CMD_DUMMY_TXT", "$mongo_base_f/usr/local/mongo_tutorial/bin/cmd_dummy.txt"); // Temp command fie </pre> It should be obvious all paths are incorrect and need updating added to this are items relating to authentication these need deleting.

First delete authentication related to give: <pre> $path_array = explode("\\usr",getcwd()); // Split at folder usr $mongo_base = $path_array[0]; // find drive letter and any sub-folders $mongo_base_f = preg_replace('/\\\/','/', $mongo_base); // Replace \ with /

//=== FOLDERS === define("MONGO_BIN", "$mongo_base_f/usr/local/mongo_tutorial/bin"); // Binaries for MongoDB

//=== FILES === define("CONFIG_NO_AUTH_F", "$mongo_base_f/usr/local/mongo_tutorial/bin/config_no_auth.ini"); define("UNISERV_EXE", "$mongo_base_f/usr/local/mongo_tutorial/bin/uniserv.exe"); // Utility define("UNISERV_EXE_B", $mongo_base.'\usr\local\mongo_tutorial\bin\uniserv.exe'); // Utility define("MON_PSKILL_EXE", "$mongo_base_f/usr/local/mongo_tutorial/bin/pskill.exe"); // Utility </pre> First line splits current working directory at folder usr this requires changing. Choose a folder that is common to folders usr and unicon, in this case use folder UniServer

With this split we have a reference $mongo_base that is a path up to folder UniSerer hence this folder must be added to the paths being reconstructed.

Top

Paths

After making the changes section looks like this: <pre> $path_array = explode("\\UniServer",getcwd()); // Split at folder usr $mongo_base = $path_array[0]; // find drive letter and any sub-folders $mongo_base_f = preg_replace('/\\\/','/', $mongo_base); // Replace \ with /

//=== FOLDERS === define("MONGO_BIN", "$mongo_base_f/UniServer/usr/local/mongo/bin"); // Binaries for MongoDB

//=== FILES === define("CONFIG_NO_AUTH_F", MONGO_BIN."/config_no_auth.ini"); define("UNISERV_EXE", MONGO_BIN."/uniserv.exe"); // Utility define("UNISERV_EXE_B", $mongo_base.'\UniServer\usr\local\mongo\bin\uniserv.exe'); // Utility define("MON_PSKILL_EXE", MONGO_BIN."/pskill.exe"); // Utility

</pre>

Top

Command Prompt

From z_mongo\temp\mongo_db_inc.php copy function open_cmd_window() to file z_mongo\UniServer\unicon\tray_menu_2\mongo_db_inc.php

In folder alt_control create the following two files with content as shown

Top

Run_cmd.bat

<pre> TITLE UNIFORM SERVER - Run Command Prompt COLOR B0 @echo off cls

cd ..\..\php php.exe -c mongo_cli.ini ..\mongo\alt_control\run_cmd.php

pause EXIT </pre>

Comments:

  • ..\..\php Changes working folder. From current folder ..\..\ move up two folder levels and down into folder php
  • php.exe Run PHP
  • -c mongo_cli.ini Use this configuration file
  • ..\mongo\alt_control\run_cmd.php Move up one folder level and down into folder alt_control and run script run_cmd.php

Note:

After testing you can comment out the pause.

run_cmd.php

<pre> <?php

chdir(dirname(__FILE__)); // Change wd to this files location include_once "../../../../unicon/tray_menu_2/mongo_db_inc.php";

open_cmd_window(); // Run command prompt function

?> </pre>

  • Change folder to alt_control
  • Include file. Move up four folder levels down into folder tray_menu_2 and include file mongo_db_inc.php
  • Run function open_cmd_window()

Top

Test

  • Run batch file. Double click on Run_cmd.bat
  • A command window opens displaying the content of folder bin

Above confirms we have a working structure and can add further components.

Top

Support Functions

A user can change server’s working port in the configuration file.

We have a function that determines this

From z_mongo\temp\mongo_db_inc.php copy function get_mongo_port_no_auth() to file z_mongo\UniServer\unicon\tray_menu_2\mongo_db_inc.php

We will require several functions hence copy the following:

  • set_mongo_port_no_auth($new_port)
  • start_mongo_no_auth()
  • stop_mongo_no_auth()
  • client_no_auth()
  • mongodb_running()
  • mongo_client_running()

Top

Additional Scripts

Create the following scripts with content as shown

Run_start_mongo.bat

<pre>

TITLE UNIFORM SERVER - Run Start MongoDB COLOR B0 @echo off cls

cd ..\..\php php.exe -c mongo_cli.ini ..\mongo\alt_control\run_start_mongo.php

pause EXIT </pre>

run_start_mongo.php

<pre> <?php

chdir(dirname(__FILE__)); // Change wd to this files location include_once "../../../../unicon/tray_menu_2/mongo_db_inc.php";

start_mongo_no_auth(); // Run start mongo function ?> </pre>

Run_stop_mongo.bat

<pre>

TITLE UNIFORM SERVER - Run Stop MongoDB COLOR B0 @echo off cls

cd ..\..\php php.exe -c mongo_cli.ini ..\mongo\alt_control\run_stop_mongo.php

pause EXIT </pre>

run_stop_mongo.php

<pre> <?php chdir(dirname(__FILE__)); // Change wd to this files location include_once "../../../../unicon/tray_menu_2/mongo_db_inc.php";

stop_mongo_no_auth() ; // Run command prompt function ?> </pre>

Run_client.bat

<pre> TITLE UNIFORM SERVER - Run Mongo Client COLOR B0 @echo off cls

cd ..\..\php php.exe -c mongo_cli.ini ..\mongo\alt_control\run_client.php

pause EXIT </pre>

run_client.php

<pre> <?php chdir(dirname(__FILE__)); // Change wd to this files location include_once "../../../../unicon/tray_menu_2/mongo_db_inc.php";

client_no_auth() ; // Run command prompt function ?> </pre>

Top

Test

  • Start server double click on Run_start_mongo.bat wait a short time
  • Run client double click on Run_client.bat check connection is made. Type exit
  • Stop server double click on Run_stop_mongo.bat wait a short time
  • Run client double click on Run_client.bat check connection fails.

Top

Summary

I was asked why do you need the PHP CLI scripts? They were included only to test each associated function.

Thinking about that question the user had not missed the point what they wanted were pure batch files no PHP.

I have addressed the above on the next page Alternative control 2


Top