Configurable title text

In the next Linodef version you may set HTML attributes like title: #560042: Add option "attributes" to allow html attributes in embedded tags

However being able to alter the title for simple [#nid] tags would be useful. The approach using a variable and the token module seems fine. But the addition of the variable should happen in _linodef_find_nodesnfields() (linodef-filter.inc) where the hard coded title is added (line 264). Furthermore the patch of #1 violates a Drupal rule: using a variable for the first parameter of t(). This will cause problems with potx.

When this feature is RTBC adding a separate customizable title for terms and views might also be sufficient.

You are correct. Your patch already changes the title at the correct place. I'm sorry, I misread it yesterday.

So as you said in #3, passing $format to the filter process functions (e.g. _linodef_find_nodesnfields($nid, $options = array(), $format)) is the way of choice and linodef_filter_format() you dislike won't be needed then (actually this feature is desirable :) ).

^{/me wondering why I used _linodef_filter_process($text, $format) in hook_filter but didn't use the $format parameter in linodef-filter.inc. With your patch this is fixed also. :)}

It would be nice if you could change this part in your code and patch it against rc3 as before.

Btw, instead of t() str_replace() or similar should be used:

However tempting it is, custom data from user input or other non-code sources should not be passed through t(). [...] Instead, translation of these data can be done through the locale system, either directly or through helper functions provided by contributed modules.

I haven't worked with the locale module yet, so I have no experience how to handle translations for admin settings textfields. However the translation of the title is secondary.

Thanks for your contribution, the patches themselves are working fine!
Unfortunately there are some glitches with token_replace(). It aborts the calling function (e.g. _linodef_find_nodesnfields()) and causing _linodef_filter_process to run again in certain/unknown circumstances. That is confusing since token_replace() doesn't load the input filter of the $node object. Also the tokens ([nid] etc) aren't replaced then. I'm still tracking down the problem, maybe the fault lies at Linodef. My code for debugging:

function _linodef_filter_process(&$body, $format = -1) {
	print('_linodef_filter_process has been called with format ' . $format . '<br />');
//
//_linodef_find_nodesnfields
				$attributes = array('title' => variable_get("linodef_node_title_$format", LINODEF_NODE_TITLE_FORMAT), 'class' => $class);
				print('Title node <b>' . $node->nid . '</b> in format <b>' . $format . '</b>: raw: <b>' . $attributes['title'] . '</b>'); // Debug
				if (module_exists('token')) {
					$attributes['title'] = token_replace($attributes['title'], 'node', $node);
				} else {
					$attributes['title'] = str_ireplace(array('[title]', '[nid]'), array($node->title, $node->nid), $attributes['title']);
				}
				print(' replaced: <b>' . $attributes['title'] . '</b><br />'); // Debug

The output (node with two textfields using Linodef tags):

_linodef_filter_process has been called with format 2
Title node 78 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node artikel: Cui Gilvus Voco Adipiscing
// Here unexpected behavior starts. The second print function of the debug code above is not called (replaced:).
// So why calls token_replace() _linodef_filter_process() again? Tokens aren't replaced either now. This might help
// to track down the reason.
Title node 101 in format 2: raw: FULL Node [type]: [title]_linodef_filter_process has been called with format 2
Title node 78 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
Title node 101 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
_linodef_filter_process has been called with format 2
Title node 78 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
Title node 101 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
// Now the second print function is executed.
replaced: FULL Node artikel: Cui Gilvus Voco Adipiscing
// Now the code works as expected.
Title node 101 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node artikel: Cui Gilvus Voco Adipiscing
_linodef_filter_process has been called with format 2
Title node 78 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node artikel: Cui Gilvus Voco Adipiscing
Title node 101 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node artikel: Cui Gilvus Voco Adipiscing

When removing token_replace() the output is as expected.

This problem appears always for me (EDIT: when using fields, see below). It is likely due to some other module, since the problem occurs when module_invoke_all('token_values', $type, $object, $options) in token_get_values() is executed. node_token_values() is fine, so I've checked the token_values hooks other modules are using. For that I modified module_invoke_all to print the used modules:

  foreach (module_implements($hook) as $module) {
    $function = $module .'_'. $hook;
		if ($hook == 'token_values') {
			print($module . '<br />');
		}

Correct output in my test installation:

Title node 78 in format 2: raw: FULL Node [type]: [title]book
comment
node
taxonomy
user
content
number
text
computed_field
filefield
pathauto
token
replaced: FULL Node artikel: Cui Gilvus Voco Adipiscing

Buggy output:

Title node 101 in format 2: raw: FULL Node [type]: [title]book
comment
node
taxonomy
user
content
_linodef_filter_process has been called with format 2
Title node 78 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
Title node 101 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
_linodef_filter_process has been called with format 2
Title node 78 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
Title node 101 in format 2: raw: FULL Node [type]: [title] replaced: FULL Node [type]: [title]
number
text
computed_field
filefield
pathauto
token
replaced: FULL Node artikel: Cui Gilvus Voco Adipiscing

So the calling of content_token_values() causes the bug, more precisely the line content_view($node);. I've written a bug report in CCK issue queue: #651236: content_view in content_token_values shouldn't load hook_filter

Though problem in #9 isn't resolved I'd like to comment the patch:
Since token doesn't support [view] I've changed it to [viewname] which is replaced by the view title in _linodef_find_view().

			// Get the view display title, required for option content and link formatting below.
			$view_title = $view->get_title() ? $view->get_title() : t('view %viewname', array('%viewname' => $view->name));
//...
			elseif ($options['content'] == 'title') {
				// Show view display title.
				$output = $view_title;
			}
//...
				$attributes = array('title' => variable_get("linodef_view_title_$format", LINODEF_VIEW_TITLE_FORMAT), 'class' => 'linodef linodef_view linodef_view_' . $view_title);
				$attributes['title'] = str_ireplace('[viewname]', $view_title, $attributes['title']);
				if (module_exists('token')) {
				  $attributes['title'] = token_replace($attributes['title']);
				}

Therefore the definition of the constants has changed slightly:

// Default link titles.
define("LINODEF_NODE_TITLE_FORMAT", t('Node') . ' [nid]: [title]');
define("LINODEF_TERM_TITLE_FORMAT", t('Shows a teaser list of nodes using term !term', array('!term' => '[cat-raw]')));
define("LINODEF_VIEW_TITLE_FORMAT", t('Show !view', array('!view' => '[viewname]')));

(providing a patch for these changes is awkard since I implemented #619166: "Override" option does not support apostrophe and other changes for the new taglists module in my local dev install - and manual editing of patches causes line bugs as you mentioned in #6 - it's about time to finish taglists and commit all this stuff so providing patches is easier for everyone :/ )

Oh, that's interesting; I can't reproduce it!

Could you insert the print() functions used in comment #7 in your code, please? So I can see the output at your copy & paste site. ;) However the filter result is as expected (also on my test site) so the user won't actually see this multiple calling of hook_filter. Though it can cause a duplicate appearance of Linedef info/warning/error messages. I'm not sure since the behavior of hook_filter used by cck token values seems to be different (or it is caused due to the execution inside a filter as you said). This would be nice to know.
EDIT: Nevermind, the recursion check for content_view() in token_get_values() seems to be the reason for the different behavior of token_replace in hook_filter called by CCK.

I even have it linking to itself, which somehow does not cause an infinite loop.

Linodef removes its own tags when embedding fields with Linodef tags. See this comment. Later I've introduced linodef_removetags() in main module file.

Indeed, Linodef messages are duplicated when using token_replace with fields since the complete filter process is run again. Therefore I hesitate to use token_replace() as a default method for title substitution (it will also cause a serious performance hit when using many filters or Linodef tags). Avoiding the duplication as in token_get_values() (with static $running) doesn't seem to work since the filter has to run multiple times when having several nodes on a page. Also the filter doesn't know what function calls it. What a pity! Maybe you have an idea?

I'll be off for the weekend and the plane doesn't wait so just a short reply.

Thanks for the testing of the running variant. This make things complicated while it does not provide help: It should avoid problems with textfields with input filters - but we have to unset the running var as you proposed when using these textfields - otherwise token_replace would have no effect either.

But besides making token_replace() optional and warn the admin (in form description) about its flaws we could use the objects (node/term/view) we already have at hand and provide own token-like replacements (without token module). I.e. expanding $attributes['title'] = str_ireplace(array('[title]', '[nid]'), array($node->title, $node->nid), $attributes['title']); to all the object properties that are available. I don't know if this would fulfill your needs as token does?

Btw, thanks for updating your dev site. The output is the same as at my test installation. That I wanted to ensure. :)

I've committed your proposals and added a few tokens usable without the tokens module. Just the usage of static $running is lacking completely. I'd like if you could provide a patch against the updated dev release.

@#11: Linodef shouldn't add tokens related to other modules (views).

I've edited your patch from #19 so it also prevents duplicated messages and the static running could be used for other processes, too (if needed in future). Please review for copy & paste accidents. ;)

Additionally to take those 'title' and 'class' attributes in consideration that are defined by option 'attributes' I've made a few minor changes that are not related directly to this issue (but clutter the patch, sorry).

@#15:

$buildmode = (arg(0) == 'node' && is_numeric(arg(1))) ? 'full' : 'teaser'; "not sure how you're using this, but this is going to have issues for full node views, but alas, not much can be done about that"

This is used when processing the options 'content' and 'formatter'. Actually you are right and I'd like to have a better solution for Drupal6 that heeds views/panels but don't know of it yet.

Committed to D6 branch. Thx for your contribution!