1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Catalog
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: 
 28: /**
 29:  * Product Url model
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Catalog
 33:  * @author     Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Catalog_Model_Product_Url extends Varien_Object
 36: {
 37:     const CACHE_TAG = 'url_rewrite';
 38: 
 39:     /**
 40:      * Static URL instance
 41:      *
 42:      * @var Mage_Core_Model_Url
 43:      */
 44:     protected static $_url;
 45: 
 46:     /**
 47:      * Static URL Rewrite Instance
 48:      *
 49:      * @var Mage_Core_Model_Url_Rewrite
 50:      */
 51:     protected static $_urlRewrite;
 52: 
 53:     /**
 54:      * Retrieve URL Instance
 55:      *
 56:      * @return Mage_Core_Model_Url
 57:      */
 58:     public function getUrlInstance()
 59:     {
 60:         if (!self::$_url) {
 61:             self::$_url = Mage::getModel('core/url');
 62:         }
 63:         return self::$_url;
 64:     }
 65: 
 66:     /**
 67:      * Retrieve URL Rewrite Instance
 68:      *
 69:      * @return Mage_Core_Model_Url_Rewrite
 70:      */
 71:     public function getUrlRewrite()
 72:     {
 73:         if (!self::$_urlRewrite) {
 74:             self::$_urlRewrite = Mage::getModel('core/url_rewrite');
 75:         }
 76:         return self::$_urlRewrite;
 77:     }
 78: 
 79:     /**
 80:      * 'no_selection' shouldn't be a valid image attribute value
 81:      *
 82:      * @param string $image
 83:      * @return string
 84:      */
 85:     protected function _validImage($image)
 86:     {
 87:         if($image == 'no_selection') {
 88:             $image = null;
 89:         }
 90:         return $image;
 91:     }
 92: 
 93:     /**
 94:      * Retrieve URL in current store
 95:      *
 96:      * @param Mage_Catalog_Model_Product $product
 97:      * @param array $params the URL route params
 98:      * @return string
 99:      */
100:     public function getUrlInStore(Mage_Catalog_Model_Product $product, $params = array())
101:     {
102:         $params['_store_to_url'] = true;
103:         return $this->getUrl($product, $params);
104:     }
105: 
106:     /**
107:      * Retrieve Product URL
108:      *
109:      * @param  Mage_Catalog_Model_Product $product
110:      * @param  bool $useSid forced SID mode
111:      * @return string
112:      */
113:     public function getProductUrl($product, $useSid = null)
114:     {
115:         if ($useSid === null) {
116:             $useSid = Mage::app()->getUseSessionInUrl();
117:         }
118: 
119:         $params = array();
120:         if (!$useSid) {
121:             $params['_nosid'] = true;
122:         }
123: 
124:         return $this->getUrl($product, $params);
125:     }
126: 
127:     /**
128:      * Format Key for URL
129:      *
130:      * @param string $str
131:      * @return string
132:      */
133:     public function formatUrlKey($str)
134:     {
135:         $urlKey = preg_replace('#[^0-9a-z]+#i', '-', Mage::helper('catalog/product_url')->format($str));
136:         $urlKey = strtolower($urlKey);
137:         $urlKey = trim($urlKey, '-');
138: 
139:         return $urlKey;
140:     }
141: 
142:     /**
143:      * Retrieve Product Url path (with category if exists)
144:      *
145:      * @param Mage_Catalog_Model_Product $product
146:      * @param Mage_Catalog_Model_Category $category
147:      *
148:      * @return string
149:      */
150:     public function getUrlPath($product, $category=null)
151:     {
152:         $path = $product->getData('url_path');
153: 
154:         if (is_null($category)) {
155:             /** @todo get default category */
156:             return $path;
157:         } elseif (!$category instanceof Mage_Catalog_Model_Category) {
158:             Mage::throwException('Invalid category object supplied');
159:         }
160: 
161:         return Mage::helper('catalog/category')->getCategoryUrlPath($category->getUrlPath())
162:             . '/' . $path;
163:     }
164: 
165:     /**
166:      * Retrieve Product URL using UrlDataObject
167:      *
168:      * @param Mage_Catalog_Model_Product $product
169:      * @param array $params
170:      * @return string
171:      */
172:     public function getUrl(Mage_Catalog_Model_Product $product, $params = array())
173:     {
174:         $routePath      = '';
175:         $routeParams    = $params;
176: 
177:         $storeId    = $product->getStoreId();
178:         if (isset($params['_ignore_category'])) {
179:             unset($params['_ignore_category']);
180:             $categoryId = null;
181:         } else {
182:             $categoryId = $product->getCategoryId() && !$product->getDoNotUseCategoryId()
183:                 ? $product->getCategoryId() : null;
184:         }
185: 
186:         if ($product->hasUrlDataObject()) {
187:             $requestPath = $product->getUrlDataObject()->getUrlRewrite();
188:             $routeParams['_store'] = $product->getUrlDataObject()->getStoreId();
189:         } else {
190:             $requestPath = $product->getRequestPath();
191:             if (empty($requestPath) && $requestPath !== false) {
192:                 $idPath = sprintf('product/%d', $product->getEntityId());
193:                 if ($categoryId) {
194:                     $idPath = sprintf('%s/%d', $idPath, $categoryId);
195:                 }
196:                 $rewrite = $this->getUrlRewrite();
197:                 $rewrite->setStoreId($storeId)
198:                     ->loadByIdPath($idPath);
199:                 if ($rewrite->getId()) {
200:                     $requestPath = $rewrite->getRequestPath();
201:                     $product->setRequestPath($requestPath);
202:                 } else {
203:                     $product->setRequestPath(false);
204:                 }
205:             }
206:         }
207: 
208:         if (isset($routeParams['_store'])) {
209:             $storeId = Mage::app()->getStore($routeParams['_store'])->getId();
210:         }
211: 
212:         if ($storeId != Mage::app()->getStore()->getId()) {
213:             $routeParams['_store_to_url'] = true;
214:         }
215: 
216:         if (!empty($requestPath)) {
217:             $routeParams['_direct'] = $requestPath;
218:         } else {
219:             $routePath = 'catalog/product/view';
220:             $routeParams['id']  = $product->getId();
221:             $routeParams['s']   = $product->getUrlKey();
222:             if ($categoryId) {
223:                 $routeParams['category'] = $categoryId;
224:             }
225:         }
226: 
227:         // reset cached URL instance GET query params
228:         if (!isset($routeParams['_query'])) {
229:             $routeParams['_query'] = array();
230:         }
231: 
232:         return $this->getUrlInstance()->setStore($storeId)
233:             ->getUrl($routePath, $routeParams);
234:     }
235: }
236: