Remove use of deprecated function drupal_realpath() [#1460594]

In issue #920062 drupal_realpath() was introduced into the openUri call in xmlsitemap.xmlsitemap.inc

You should *not* be using this function as it completely breaks support for using stream wrappers on remote file systems.

Take a look at the API documention http://api.drupal.org/api/drupal/includes%21file.inc/function/drupal_rea...

Returns the absolute local filesystem path of a stream URI.

This function was originally written to ease the conversion of 6.x code to use 7.x stream wrappers. However, it assumes that every URI may be resolved to an absolute local filesystem path, and this assumption fails when stream wrappers are used to support remote file storage. Remote stream wrappers may implement the realpath method by always returning FALSE. The use of drupal_realpath() is discouraged, and is slowly being removed from core functions where possible.

Only use this function if you know that the stream wrapper in the URI uses the local file system, and you need to pass an absolute path to a function that is incompatible with stream URIs.

@todo: This function is deprecated, and should be removed wherever possible.

My system works perfectly fine to merely remove drupal_realpath($uri) and replace with just $uri for that call, though I'm not sure exactly what you were trying to accomplish by adding it before. Please use something that is portable and not reliant on a local filesystem/deprecated.

Comment	File	Size	Author
#5	remove_drupal_realpath-1460594.patch	502 bytes	tripper54

Comments

Comment #1

coderintherye commented 28 February 2012 at 21:09

To further clarify, users using remote filesystems will experience the same errors as some people reported in http://drupal.org/node/920062 which are of the form: WD xmlsitemap: XMLSitemapGenerationException: Could not open file ..../1.xml for writing. in XMLSitemapWriter->openUri()

Comment #2

heathclifff commented 7 March 2012 at 20:16

Has there been any movement on this? I am having this exact problem and am very interested in having a version of this module which will work locally even if I am using remote file storage (such as amazon s3). Do you have a patch file I could use to get started? Thanks.

Comment #3

coderintherye commented 8 March 2012 at 06:30

Well, I haven't made a patch since I doubt that will be accepted, but basically just change line 40 of xmlsitemap.xmlsitemap.inc from

$return = parent::OpenUri(drupal_realpath($uri));

to instead be

$return = parent::OpenUri($uri);

Comment #4

Anonymous (not verified) commented 8 March 2012 at 13:17

Title:	use of drupal_realpath() breaks support for remote filesystems such as amazon s3	» Remove use of deprecated function drupal_realpath()
Priority:	Major	» Normal

Comment #5

tripper54 commented 21 September 2012 at 04:08

Status:

Active

» Needs review

Status	File	Size
new	remove_drupal_realpath-1460594.patch	502 bytes

Patch attached for review - simply made the changes in #3.

Thanks @coderintherye.

This fixed the errors on my site, which uses s3 as its default storage location.

Comment #6

Anonymous (not verified) commented 21 September 2012 at 11:25

Status:

Needs review

» Reviewed & tested by the community

Comment #7

coderintherye commented 30 September 2012 at 05:49

Nice, thanks for patching & reviewing, I hope to see this make it in.

Comment #8

sealionking commented 10 October 2012 at 01:56

thanks very much

it works for mine with s3

Comment #9

dave reid

he/him

English

Nebraska USA

commented 8 December 2012 at 00:02

So if this works for remote file systems, how does this work on systems where using $uri natively was an issue, like Windows? Does this cause a regression?

Comment #10

coderintherye commented 11 December 2012 at 07:22

Possibly, is there a test case for that? Or a windows test machine we can throw a potential test case at if we were to create a simpletest for it?

Comment #11

Anonymous (not verified) commented 17 December 2012 at 17:48

I'm testing this on my WAMP. So far so good. Where would one expect to see an issue? There is none going to sitemap.xml.

Comment #12

coderintherye commented 11 February 2013 at 05:24

I believe any issue here would be that the file itself would not be generated properly, so if it works to delete the file and the module recreates it, and updates it when you add a new node, and in addition you can open the sitemap.xml via a browser, then it should be all good.