Sometimes you want to know in a simple PHP script what the current URL (the URL through which the PHP script is called) is. When I was looking for a solution without reinventing the wheel, I actually found no piece of PHP code that met my expectations. So let me try it as well.

From which components does a URL consist?

The format of a URL looks like this:

	protocol://username:password@host:port/path?query#fragment

This URL format is not only used for the World Wide Web. For example, it is also used to communicate or configure the required data for access to a database. Since everyone uses URLs almost daily, I do not need to describe the different parts of the URL further.

I assume that if you want to use the full URL in your PHP code, you do not want to include the credentials (username and password) to prevent them from being used in an undesired way. Also, the fragment will never be passed through the CGI interface so you can not use it either.

Which data are available to you in PHP?

Using the function phpinfo() for example, you can see in PHP which data is available to you to determine the current URL:

The solution?

Using this we can generate the following function:

<?php
	function get_current_url()
	{
		$url = false;

		// check whether this script is being run as a web page
		if (isset($_SERVER['SERVER_ADDR']))
		{
			$is_https	= isset($_SERVER['HTTPS']) && 'on' == $_SERVER['HTTPS'];
			$protocol   = 'http' . ($is_https ? 's' : '');
			$host       = isset($_SERVER['HTTP_HOST'])
							? $_SERVER['HTTP_HOST']
							: $_SERVER['SERVER_ADDR'];
			$port       = $_SERVER['SERVER_PORT'];
			$path_query = $_SERVER['REQUEST_URI'];

			$url = sprintf('%s://%s%s%s',
				$protocol,
				$host,
				$is_https
					? (443 != $port ? ':' . $port : '')
					: ( 80 != $port ? ':' . $port : ''),
				$path_query
			);
		}

		return $url;
	}

Bonus

As a bonus, I give you English manual page for the get_current_url() function.
And the gist URL is: https://gist.github.com/Magentron/05ee3b8f62886878c2f1c3d76e8e3696

If you have any improvement or suggestion to share, please leave a message below.

Many times when I checking for example access or error logs, I need to know my public or external IP address (these days most people by now should be using NAT at home because their Internet access router configures it out of the box so that they cannot simply use ifconfig or ipconfig to see which IP address is in use).

To do so I would have more or less two options:

1. Retrieve the public IP address from the router, or
2. Consult an external server to provide me with the external IP address I'd be using to access that server.

Since routers come in many brands, types and operating systems, it is not generally possible to retrieve any information from it in a standard way. Furthermore, you might just be a simple user of the network that is not responsible for the network administration and as such you would not have access to the router to begin with.

So, that leaves us with the second option. There are many websites that provide a service for you to know your remote IP address, optionally with additional information such as your location, browser, supported languages, screen size, and what not. For me the most used sites are whatsmyip.net, whatsmyip.org and whatsmyip.com, but there are many more.

However, I'm to lazy to open a tab in my browser and type any of those URLs, I'm faster with the command line... ☺

Instead I wrote a simple PHP script to help me with that. The result is in.je/ip, which you can easily call using curl or wget:

• curl in.je/ip
• wget -qO - in.je/ip

Example:

jeroen@dev:~$ time curl in.je/ip
66.249.76.156

real    0m0.103s
user    0m0.007s
sys     0m0.007s

So it complies with the first requirement of working from the command line, where you can for example pipe it into a different program if necessary.

Also, it supports different kinds of output data and formats, such as binary, DNS, GeoIP information, HTML, Javascript, PHP, shell scripts, API, XML or SOAP requests, etc. For example to do reverse DNS lookup just use:

jeroen@dev:~$ curl in.je/ip/rdns
crawl-66-249-76-156.googlebot.com

Please go to in.je/ip to read about all the features.

Enjoy!

If you have any improvement or suggestion to share, please leave a message via the link below.

• CVE-2016-10033 - PHPMailer < 5.2.18 Remote Code Execution
• CVE-2016-10045 - PHPMailer < 5.2.20 Remote Code Execution (0day Patch Bypass/exploit)

phpmailer-upgrade.sh v1.0.0 - Copyright (c) 2016 Derks.IT / Jeroen Derks
Upgrades PHPMailer files automatically to last version

usage: upgrade-phpmailer.sh [-d] [-n] [-v] [-x] [-B branch] [-C checkout] [-D backup ]
[-K] [-M extension] [-N] [-O] directory [ directory [...] ]
    -d    Enable debug output
    -n    Dry-run mode
    -v    Enable verbose output
    -x    Enable shell debug output
    -B    PHPMailer GitHub branch name to use (default: master)
    -C    Directory containing cloned repository with branch to use
    -D    Backup directory to use (default: /phpmailer.backup)
    -K    Keep temporary directory
    -M    Rename original files using supplied extension (default: .BACKUP)
    -N    Do not create backup directory
    -O    Compare only, do not actually upgrade

NB: Please note that this post is a work-in-progress, your mileage may vary, so please test thorougly before using this solution in a production environment.
Please let me know if you find any problems with this solution. Thanks!

<?php
    // load product
    /** @var Mage_Catalog_Model_Product $product */
    $product = Mage::getModel('catalog/product')
                    ->setStoreId($storeId)
                    ->load($productId);

    // set length of coupon code
    /** @var Mage_SalesRule_Model_Coupon_Codegenerator $generator */
    $generator = Mage::getModel('salesrule/coupon_codegenerator')
                        ->setLength(8);
    /** @var Mage_SalesRule_Model_Rule_Condition_Product $conditionProduct */
    $conditionProduct = Mage::getModel('salesrule/rule_condition_product')
                                                ->setType('salesrule/rule_condition_product')
                                                ->setAttribute('sku')
                                                ->setOperator('==')
                                                ->setValue($product->getSku());
                                                
    /** @var Mage_SalesRule_Model_Rule_Condition_Product_Found $conditionProductFound */
    $conditionProductFound = Mage::getModel('salesrule/rule_condition_product_found')
                                            ->setConditions(array($conditionProduct));
    /** @var Mage_SalesRule_Model_Rule_Condition_Combine $condition */
    $condition = Mage::getModel('salesrule/rule_condition_combine')
                    ->setConditions(array($conditionProductFound));
                                                
    /** @var Mage_SalesRule_Model_Coupon $coupon */
    $coupon = Mage::getModel('salesrule/coupon');
    // try to generate unique coupon code
    $attempts = 0;
    do {
        if ($attempts++ >= 8) {
            Mage::throwException(Mage::helper('mymodule')->__('Unable to create requested Coupons. Please try again.'));
        }
        $code = $generator->generateCode();
    } while ($coupon->getResource()->exists($code));

    // create rule
    /** @var Mage_SalesRule_Model_Rule $rule */
    $rule = Mage::getModel('salesrule/rule');
    $rule->setName(Mage::helper('mymodule')->__('Name of the coupon'))
        ->setDescription($rule->getName())
        ->setFromDate(date('Y-m-d'))
        ->setCustomerGroupIds($this->_getCustomerGroups())
        ->setIsActive(1)
        ->setConditionsSerialized(serialize($condition->asArray()))
        //->setActionsSerialized     
        //->setStopRulesProcessing 
        //->setIsAdvanced                     
        ->setSimpleAction(Mage_SalesRule_Model_Rule::BY_FIXED_ACTION)
        ->setDiscountAmount($product->getFinalPrice())
        ->setDiscountQty(1)
        //->setDiscountStep                     
        ->setStopRulesProcessing(0)
        ->setIsRss(0)
        ->setWebsiteIds(array(1))
        ->setCouponType(Mage_SalesRule_Model_Rule::COUPON_TYPE_SPECIFIC)
        ->setConditions($condition)
        ->save();            
    
    // create coupon
    $coupon->setId(null)
        ->setRuleId($rule->getRuleId())
        ->setCode($code)
        ->setUsageLimit(1)
        //->setUsagePerCustomer
        //->setTimesUsed
        //->setExpirationDate
        ->setIsPrimary(1)
        ->setCreatedAt(time())
        ->setType(Mage_SalesRule_Helper_Coupon::COUPON_TYPE_SPECIFIC_AUTOGENERATED)
        ->save();

Please let me know if this works for you or not!

The idea is to simply call the same function for login() which would be used in the frontend and then check for customer authentication in every API call that requires customer authentication.

NB: Please note that this post is a work-in-progress, your mileage may vary, so please test thorougly before using this solution in a production environment.

Update: changed to use customer session for storing current website and store.
Please let me know if you find any problems with this solution. Thanks!

Don't forget that you also have to setup API access in the Magento administration area.

First you need to define a function in your API class to handle the customer login:

<?php
/**
 * Custom API model
 */
class MyCompany_MyModule_Model_Api extends Mage_Api_Model_Resource_Abstract
{
    /** @var Mage_Customer_Model_Session */
    protected $_customerSession = null;

    /**
     * Customer authentication.
     *
     * @param   string  $website Website code of website to authenticate customer against
     * @param   string  $username Username of customer to authenticate
     * @param   string  $password Password of customer to authenticate
     * @return  boolean True, if successfully authenticated customer for supplied website; false, otherwise.
     */
    public function login( $website, $email, $password )
    {
        // determine store to login to
        $store = $this->_getStore($website);

        // get customer session object
        $session = $this->_getCustomerSession();

        // authenticate customer
        $authenticated = $session->login($email, $password);

        // return authentication result
        return $authenticated;
    }

    /**
     * Logout authenticated customer, if any.
     * @return boolean True.
     */
    public function logout()
    {
        // get customer session object
        $session = $this->_getCustomerSession();
        
        // logout customer
        $session->logout();

        return true;
    }

Next, you have to check for an authenticated customer in your API functions that require this:

    /**
     * Do something for an authenticated customer.
     */
    public function doSomethingThatRequiresCustomerAuthentication()
    {
        // check whether customer is actually authenticated
        $this->_checkCustomerAuthentication();

        // retrieve customer object
        $customer = $this->_getAuthenticatedCustomer()

        // do something for authenticated customer
        ...
    }

Finally, you have to define the helper functions we have used:

    /**
     * Check whether a customer has been authenticated in this session.
     * 
     * @return void
     * @throws Mage_Core_Exception If customer is not authenticated.
     */
    protected function _checkCustomerAuthentication()
    {
        // get customer session object
        $session = $this->_getCustomerSession();
        
        // check whether customer is logged in
        if ( !$session->isLoggedIn() ) {
            // if customer is not logged in throw an exception
            Mage::throwException(Mage::helper('mymodule')->__('Not logged in'));
        }
    }

    /**
     * Get authenticated customer object.
     * 
     * @return Mage_Customer_Model_Customer Authenticated customer object.
     * @throws Mage_Core_Exception If customer is not authenticated or does not exist.
     */
    protected function _getAuthenticatedCustomer()
    {
        // retrieve authenticated customer ID
        $customerId = $this->_getAuthenticatedCustomerId();
        if ( $customerId )
        {
            // load customer
            /** @var Mage_Customer_Model_Customer $customer */
            $customer = Mage::getModel('customer/customer')
                            ->load($customerId);
            if ( $customer->getId() ) {
                // if customer exists, return customer object
                return $customer;
            }
        }
        
        // customer not authenticated or does not exist, so throw exception
        Mage::throwException(Mage::helper('mymodule')->__('Unknown Customer'));
    }

    /**
     * Get authenticated customer ID.
     * 
     * @return integer Authenticated customer ID, if any; null, otherwise.
     */
    protected function _getAuthenticatedCustomerId()
    {
        // get customer session object
        $session = $this->_getCustomerSession();
        
        // return authenticated customer ID, if any
        return $session->getCustomerId();
    }

    /**
     * Get store object from supplied website code or from register or session.
     * 
     * @param string $code Code
     */
    protected function _getStore( $code = null )
    {
        // get customer session
        $session = $this->_getCustomerSession();

        // if website code not supplied, check for selected store in register or selected website in session
        if ( null === $code ) {
            // try to get selected store from register
            $store = Mage::registry('current_store');
            if ( $store ) {
                return $store;
            }
                
            // try to get selected website code from session
            $code = $session->getCurrentWebsiteCode();
            if ( !$code ) {
                // if no store in register or website code in session, throw an exception
                Mage::throwException(Mage::helper('mymodule')->__('No Store set'));
            }
        }

        // load website from code
        /** @var Mage_Core_Model_Website $website */
        $website = Mage::getModel('core/website')
                        ->load($code, 'code');
        if ( !$website->getId() ) {
            // if unknown website, throw an exception
            Mage::throwException(Mage::helper('mymodule')->__('Invalid Store') . $code);
        }
        
        // get the default store of the website
        $store = $website->getDefaultStore();
        
        // register the current store
        Mage::app()->setCurrentStore($store);
        Mage::register('current_store', $store, true);
        
        // set the current website code in the session
        $session->setCurrentWebsiteCode($website->getCode());
        
        // return store object
        return $store;
    }

    /**
     * @return Mage_Customer_Model_Session
     */
    protected function _getCustomerSession()
    {
        if ( !$this->_customerSession ) {
            $this->_customerSession = Mage::getSingleton('customer/session');
        }
        return $this->_customerSession;
    }

    ...
}

Please let me know if this works for you or not!

Magento

• Tax
• Quotes
• Orders
• Invoices/Creditmemos
• EAV (customer, catalog, product, etc)
• Multi-language website
• Shipping
• Payment
• Overriding models/blocks
• Overriding controller
• Config XML
• Debugging
• Performance

Debugging

Logging

IDE / Editor

Version control

Quality Assurance (QA)

Issue tracking / Project management

Apache

MySQL

Cron

• System Config Search by Alan Storm

  This is one of the most useful extensions for novice users. It allows you to search through the system configuration options in the administration area. Not only novice users will benefit from this extension, but also seasoned developers sometimes may forget where exactly certain configuration options are available.

• Magneto Debug by Sorin Stoiana

  This is also one of the most useful extensions, but then for developers and designers. Using a non-obtrusive element on the frontend you can quickly see:

  • which modules are in use and what versions
  • how long it took to generate the page and how much memory was used
  • the current configuration
  • controller and request data
  • which models have been used for the page
  • which layout configuration was used
  • which blocks were used

• Image Clean by Defcon2

  For most clients some sort of import is necessary. While importing usually images for products get configured multiple times causing multiple copies in the media/catalog/product folder. Using this extension you can find the images in that directory that cannot be found in the products data and remove them to reclaim diskspace.

• Clever CMS by Johann Reinke

  If you want to have a simple CMS tree structure, this extension works nicely out of the box. Beware that a copy is made of the current CMS pages upon installation, so if you would uninstall or disable the module your old CMS pages would become visible again.

• WordPress Integration by FishPig

  If you want to have a more advanced CMS, you can integrate WordPress right into Magento. After some configuration you can quickly have your new or existing (possibly remote) WordPress blog integrated into your Magento website.

• Module List by Pulse Storm LLC (Alan Storm)

  As all Magento developers and users will know, functionality can be added or modified by installing modules. To have an overview of the installed modules in the administration area, you can use Module List.

• Vertical Navigation by Rico Neitzel

  The default header menu might suffice, but sometimes the design requires a vertical menu for navigating the catalog. This extension will make that very easy and it's very easy to customise.

• PHPUnit Testing Integration by EcomDev (Ivan Chepurnyi)

  Recently I came across the quote "If you want to improve your software, don't test more; develop better." However, I do not think that works unless you include testing as part of development. So, to help you out, this extension will help you to write unit tests for your Magento code. It comes with a lot of documentation and you can take a look at the test classes for my EmailImages extension at GitHub.

• Email Template Adapter by Finn

  One of the things that escape my attention sometimes (although less and less lately) are the emails sent by Magento. Personally I'm not that fond of the configuration of the emails, but since I have discovered this extension, it is very easy to add a design to all outgoing emails.

If you know of an extension that should be mentioned here, please let me know via a comment or email, thanks!

I could not find much about it on the internet, but after reading Uploaded products do not show on front end, my brain started working again and I thought: "Eureka! It has to be the locale setting of the backend" (which I fageuly remember being changed after installing locale files). Unfortunately Magento's import functionality uses a text value for some fields. Depending on the configured locale different texts are used for the same values. So, if you have an import that works on one locale (let's say en_US), then it most probably will not work using another locale (and actually break the site in a very unprofessional way).

Hopefully this post will be able to help some other Magenteers, good luck and may the force be with you!

It does not happen often, but sometimes my computer crashes. Unfortunately, but such is the live of a computer user. Most programs and their data are fine after, however, Thunderbird is not one of those. Sometimes after the crash, the popstate.dat file is either corrupted, empty or missing. See also Thunderbird bug #263142

This causes Thunderbird to retrieve all the email messages that were kept at the server to be downloaded again. After another one of those incidents I decided to try and find a work-around for it. Luckily the format of the popstate.dat file is pretty straightforward. Retrieving the UIDL list for the emails stored at the server is key to the solution.

To make things easy, I have written a simple PHP script that will rebuild Thunderbird's popstate.dat file based on the emails stored at the server. Usage is pretty straightfoward.

usage: rebuild_popstate.php [-c] [-d] [-i n] [-s] [-v] [-f file] server [ port ]
-c CRLF flag, use when talking to Windows servers
-d debug flag
-f output filename
-i ignore the last n messages (for if you don't have them yet)
-s use for secure POP3 (SSL/TLS)
-v verbose flag

You can find the script at github: rebuild_thunderbird_popstate

I hope it helps, and if so it would be nice if you could share your experiences here, thanks!

First, you might add a function to your helper class to retrieve the extension version:

	public function getExtensionVersion()
	{
		return (string) Mage::getConfig()->getNode()->modules->MyCompany_MyModule->version;
	}

Second, you should create a admin block to display this version e.g. in MyCompany/MyModule/Block/Adminhmtl/Version.php:

class MyCompany_MyModule_Block_Adminhtml_Version
    extends Mage_Adminhtml_Block_System_Config_Form_Field
{
	protected function _getElementHtml(Varien_Data_Form_Element_Abstract $element)
	{
		return (string) Mage::helper('mymodule')->getExtensionVersion();
    }
}

Lastly, you configure the block in your MyCompany/MyModule/etc/system.xml:

	...
	
		
			MyModule extension version
	                select
	                MyCompany_MyModule_Block_Adminhtml_Version
	                0
	                1
	                1
	                1
		
	...
	
	...

Of course, then your have to flush the cache, and go to the appropriate admin configuration section.

Please let us know whether you found this article interesting, any comment is welcome!

]]>