Skip to content

Commit

Permalink
Merge pull request #1 from satish-nikam/master
Browse files Browse the repository at this point in the history 
Ready for release on Interop-Bridges
  • Loading branch information
@blobaugh
blobaugh committed Jul 26, 2011
2 parents 9480f6e + 9674479 commit 05ff23e
Show file tree
Hide file tree
Showing 22 changed files with 2,959 additions and 0 deletions.
184 changes: 184 additions & 0 deletions CloudPaaS/Readme.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
copyright 2011 Copyright © Microsoft Corporation. All Rights Reserved.
license http://www.opensource.org/licenses/bsd-license.php BSD License
version Release: 1.0.0
link https://github.com/Interop-Bridges/Cloud-Rules-for-PHP_CodeSniffer


CONTENTS OF THIS FILE
---------------------
* CloudPaaS Functions Sniff
* Requirement
* Installation
* How to Run
* Customization


CloudPaaS Functions Sniff
-------------------------

CloudPaaS contains the 3 sniff classes each for Local FileSystem, Session and Database.

1) CloudPaaS.Functions.LocalFileSystem
This sniff find out PHP-Local FileSystem API which are not stateless and scalable on Cloud platform.


2) CloudPaaS.Functions.Session
This sniff find out PHP-Session API which are not stateless and scalable on Cloud platform.

3) CloudPaaS.Functions.Database
This sniff find out PHP-Database API which are not stateless and scalable on Cloud platform.


These are defined in following format.

Severity-ErrorType-ErrorCode-Function Name

Severity Integer Severity for function.(between 0-5)
ErrorType String Error Type can be Error or Warning.
ErrorCode Integer Error Code for function.(eg.2001,2002)
Function Name String This can be either full function name or regular expression for finding match pattern function.(eg.Fwrite,mysql_*);

eg. 5-warning-2014-mysql_*,5-error-1026-chmod.



Requirements
------------

Note that the CloudPaaS requires the PHP_CodeSniffer package to be installed in PEAR enviorment. Install the PHP_CodeSniffer using following command.
pear install PHP_CodeSniffer-1.3.0
or visit the following link for installation.
http://pear.php.net/package/PHP_CodeSniffer


Installation
------------

1) Download https://github.com/downloads/Interop-Bridges/Cloud-Rules-for-PHP_CodeSniffer/CloudPaaS.zip

2) Unzip CloudPaaS.zip.

3) Copy the CloudPaaS folder and place it under the CodeSniffer/Standard folder of PHP_CodeSniffer installed directory.


How to run
----------
If you want to check an entire directory against all CloudPaaS Standard sniff, simply specify the directory path along with standard to phpcs as follows.

phpcs --standard=CloudPaaS /path/to/code

This will run all sniffs included in CloudPaaS.

a) Individual sniff
If you want to check an entire directory against individual sniff, specify sniff name along with standard and directory path as follows.

phpcs --standard=CloudPaaS --sniff=sniff-name /path/to/code


eg.- To find out only Database function

phpcs --standard=CloudPaaS --sniff=CloudPaaS.Functions.Database /path/to/code

This will run the only database sniff and find out the PHP-Database API.

For Local FileSystem use CloudPaaS.Functions.LocalFileSystem
For Session use CloudPaaS.Functions.Session.

b) Multiple sniff
If you want to check an entire directory against multiple sniff, specify sniff names along with standard and directory path as follow.

phpcs --standard=CloudPaaS --sniff=sniff1,sniff2 /path/to/code


eg.- To find out Database and Session API

phpcs --standard=CloudPaaS --sniff=CloudPaaS.Functions.Database,CloudPaaS.Functions.Session /path/to/code



Customization
-------------
You can include CloudPaaS Sniffs in your own standard and override the properties for each sniff in ruleset.xml as follows.

1) Define new function list.
You can override the default function list defined in sniffs as follows.

<property name="functionList" type="array" value="5-error-2003-fopen,5-warning-2004-fread,5-error-2005-fwrite">

*Value passed to property should be in "Severity-ErrorType-ErrorCode-Function Name" format.

2) Add new functions to the default function list.
You can add new functions to the default list defined in sniffs using 'addFunctions' property in ruleset.xml as follows,

<property name="addFunctions" type="array" value="5-error-2111-fopen">

*Value passed to property should be in "Severity-ErrorType-ErrorCode-Function Name" format.

3) Ignore function execution.
You can ignore the function execution using 'ignoreFunctions' property in ruleset.xml as follows,

<property name="ignoreFunctions" type="array" value="fopen,fwrite">

*Value passed to property should be only Function Name.

4) Find out the functions of particular error codes.
You can find out the functions particular error codes using 'errorCodes' property in ruleset.xml as follows,

<property name="errorCodes" type="array" value="2001,2002">

*Value passed to property should be only Error Codes.

5) Ignore error codes from execution.
You can ignore the error codes from execution using 'ignoreCodes' property in ruleset.xml as follows,

<property name="ignoreCodes" type="array" value="fopen,fwrite">

*Value passed to property should be only Function Name.

6) Show/hide line of code in the error message.
You can show/hide the line of code in error message output using 'showLineOfCode' property as follows,

<property name="showLineOfCode" value="true/false">

By default the value is 'true'.

7) Regular expression match.
If you want to find the functions using regular expression, then set the 'regxFlag' property value to 'true'.

<property name="regxFlag" value="true/false">

By default for LocalFileSystem ,'regxFlag' value is false.
For Database and Session , 'regxFlag' value is true.


Example how to override the Properties
--------------------------------------
You can include the CloudPaaS sniffs into your standards and override the properties for each sniff as follows.

<!-- Include the CloudPaaS.Functions.LocalFileSystem sniff and override the properties--->
<rule ref="CloudPaaS.Functions.LocalFileSystem">
<properties>

<!-- Override the default function list.-->
<property name="functionList" type="array" value="5-error-2001-fopen,5-error-2002-fwrite,5-warning-2003-dirname" />

<!-- Ignore function execution.-->
<property name="ignoreFunctions" type="array" value="fopen,dirname" />

<!-- Add new functions to the default function list.-->
<property name="addFunctions" type="array" value="5-error-2005-fgets" />

<!-- Ignore Error Codes from execution.-->
<property name="ignoreCodes" type="array" value="2001,2005" />

<!--Find out the functions of perticular error codes.-->
<property name="errorCodes" type="array" value="2002" />

<!--Regular expression match.-->
<property name="regxFlag" value="false" />

<!--Show/hide line of code in the error message.-->
<property name="showLineOfCode" value="true" />

</properties>
</rule>
83 changes: 83 additions & 0 deletions CloudPaaS/Sniffs/Functions/DatabaseSniff.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<?php

/**
* CloudPaaS_Sniffs_Functions_DatabaseSniff.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer_CloudPaaS
* @author Gaurav Deshmukh <v-gadesh@microsoft.com>
* @copyright 2011 Copyright © Microsoft Corporation. All Rights Reserved
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.0.0
* @link https://github.com/Interop-Bridges/Cloud-Rules-for-PHP_CodeSniffer
*/

/**
* CloudPaaS_Sniffs_Functions_DatabaseSniff.
*
* Find out the PHP-Database API.
*
* @category PHP
* @package PHP_CodeSniffer_CloudPaaS
* @author Gaurav Deshmukh <v-gadesh@microsoft.com>
* @copyright 2011 Copyright © Microsoft Corporation. All Rights Reserved
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.0.0
* @link https://github.com/Interop-Bridges/Cloud-Rules-for-PHP_CodeSniffer
*/

class CloudPaaS_Sniffs_Functions_DatabaseSniff extends
CloudPaaS_Sniffs_GenericRuleParser
{
/**
* Constructor.
*
* Set the default values.
*/
function __construct()
{
// Default function list for database.//
// Format: Severity-ErrorType(Error/Warning)-ErrorCode-Function Name.//
$this->functionList= array (
'5-warning-2001-cubrid_*',
'5-warning-2002-dbase_*',
'5-warning-2003-dbplus_*',
'5-warning-2004-fbsql_*',
'5-warning-2005-filepro_*',
'5-warning-2006-ibase_*',
'5-warning-2007-ifx_*',
'5-warning-2008-db2_*',
'5-warning-2009-ingres_*',
'5-warning-2010-maxdb_*',
'5-warning-2011-bson_*',
'5-warning-2012-msql_*',
'5-warning-2013-mssql_*',
'5-warning-2014-mysql_*',
'5-warning-2015-mysqli*',
'5-warning-2016-mysqlnd_*',
'5-warning-2017-mysqlnd_ms_*',
'5-warning-2018-mysqlnd_qc_*',
'5-warning-2019-oci*',
'5-warning-2020-ovrimos*',
'5-warning-2021-px_*',
'5-warning-2022-pg_*',
'5-warning-2023-sqlite_*',
'5-warning-2024-SQLite3*',
'5-warning-2025-sybase_*',
'5-warning-2026-TokyoTyrant*'
);

$this->regxFlag=true;

$this->message = "Please consider using PHP PDO for database access.";
$this->message .= " Found Function %s";

// Set process data flag to 0.//
$this->functionData['processFlag'] = 0;

}

}
?>
Loading

0 comments on commit 05ff23e

Please sign in to comment.